This commit is contained in:
parent
893876ddaa
commit
d5f89523db
1 changed files with 36 additions and 28 deletions
64
README.md
64
README.md
|
@ -15,34 +15,6 @@ Run `npm ci`
|
||||||
Run `npm run dev`
|
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
|
# Deploy
|
||||||
|
@ -57,3 +29,39 @@ Run `npm run build`
|
||||||
Run `npm ci`
|
Run `npm ci`
|
||||||
|
|
||||||
Run `npm test`
|
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
|
Loading…
Add table
Add a link
Reference in a new issue