add README.md
This commit is contained in:
parent
b4806db91a
commit
2fc6e78f49
1 changed files with 37 additions and 0 deletions
37
README.md
Normal file
37
README.md
Normal 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`
|
Loading…
Add table
Add a link
Reference in a new issue