svg-layout-designer-react/README.md
Eric Nguyen 7f3f6a489a Merged PR 167: Add Flex and fix bugs (read desc)
Note: The branch name does not fit the new features.

- Implement Flex with simplex
- Enable rigid body by default (removed IsRigidBody property) <=== possibly a bad idea
- Sort children in add and update properties
- Implement MaxWidth
- Add more docs

Fixes :
- .env.production url
- Symbols: not blocking the linked container when the parent is moving
2022-08-25 13:28:32 +00:00

75 lines
No EOL
1.6 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)
[![Build Status](https://dev.azure.com/enguyen0660/SVGLayoutDesignerReact/_apis/build/status/SVGLayoutDesignerReact?branchName=dev)](https://dev.azure.com/enguyen0660/SVGLayoutDesignerReact/_build/latest?definitionId=4&branchName=dev)
An svg layout designer.
# Getting Started
Requierements :
- NodeJS
- npm
- pnpm (optional but recommanded unless you prefer having a huge `node_modules` directory)
- Chrome > 98
# 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