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`