add README.md

This commit is contained in:
Hydroxycarbamide 2022-07-30 20:02:05 +02:00
parent b4806db91a
commit 2fc6e78f49

37
README.md Normal file
View file

@ -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`