svg-layout-designer-react/README.md
Siklos 27159f53d3
All checks were successful
continuous-integration/drone/push Build is passing
Update readme
2022-08-04 20:05:12 +02:00

63 lines
1.1 KiB
Markdown

# SVG Layout Designer React
[![Build Status](https://drone.siklos-chaneru.duckdns.org/api/badges/Siklos/svg-layout-designer-react/status.svg)](https://drone.siklos-chaneru.duckdns.org/Siklos/svg-layout-designer-react)
[![Build Status](https://drone.siklos-chaneru.duckdns.org/api/badges/Siklos/svg-layout-designer-react/status.svg?ref=refs/heads/dev)](https://drone.siklos-chaneru.duckdns.org/Siklos/svg-layout-designer-react)
An svg layout designer.
# Getting Started
Requierements :
- NodeJS
- NPM
# Developping
Run `npm ci`
Run `npm run dev`
## Testing the API
This program fetch the data structure from others application, 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
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
# Deploy
Run `npm ci`
Run `npm run build`
# Run the tests
Run `npm ci`
Run `npm test`