From 2fc6e78f496674ebee6d0f1e7c2031f5f5e276f3 Mon Sep 17 00:00:00 2001
From: Hydroxycarbamide <nguyen.hoang.eric@protonmail.com>
Date: Sat, 30 Jul 2022 20:02:05 +0200
Subject: [PATCH] add README.md

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ef1a8e6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# SVG Layout Designer React
+
+An svg layout designer.
+
+# Getting Started
+
+Requierements :
+- NodeJS
+- NPM
+
+# Developping
+
+Run `npm ci`
+
+Run `npm run dev`
+
+
+## Testing
+
+Install `bun`
+
+Inside `test-server` folder, run :
+
+```bash
+bun run http.js
+```
+
+The web server will be running at localhost:5000
+
+Configure the file `.env.development` with the url
+
+
+# Deploy
+
+Run `npm ci`
+
+Run `npm run build`