add README.md

2022-07-30 20:02:05 +02:00 · 2022-07-30 20:02:05 +02:00 · 2fc6e78f49
commit 2fc6e78f49
parent b4806db91a
1 changed files with 37 additions and 0 deletions
--- a/README.md
+++ 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`