svg-layout-designer-react/README.md
Siklos d5f89523db
All checks were successful
continuous-integration/drone/push Build is passing
Update Readme
2022-08-05 14:11:30 +02:00

67 lines
No EOL
946 B
Markdown

# SVG Layout Designer React
An svg layout designer.
# Getting Started
Requierements :
- NodeJS
- NPM
# Developping
Run `npm ci`
Run `npm run dev`
# Deploy
Run `npm ci`
Run `npm run build`
# Run the tests
Run `npm ci`
Run `npm test`
# API
You can preload a state by setting the `state` URL parameter
with a url address to a `state.json` file.
Example: `http://localhost:4000/?state=http://localhost:5000/state.json`
# Testing the external API
This program fetch the data structure from others applications, allowing it to assemble them later.
## With NodeJS
```bash
node run ./test-server/node-http.js
```
The web server will be running at `http://localhost:5000`
Configure the file `.env.development` with the url
## With bun.sh
Install `bun`
Inside `test-server` folder, run :
```bash
bun run http.js
```
The web server will be running at `http://localhost:5000`
Configure the file `.env.development` with the url