From d5f89523dbd9b812d74bc613fbf94a47aed5d74d Mon Sep 17 00:00:00 2001 From: Siklos Date: Fri, 5 Aug 2022 14:11:30 +0200 Subject: [PATCH] Update Readme --- README.md | 64 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 36 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 5ecff80..7fa3b5c 100644 --- a/README.md +++ b/README.md @@ -15,34 +15,6 @@ 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 @@ -57,3 +29,39 @@ Run `npm run build` 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 \ No newline at end of file