From 9547e4d1d1c21a3912ddd00640493b71f20ff1ec Mon Sep 17 00:00:00 2001 From: Eric Nguyen Date: Mon, 10 Oct 2022 09:37:53 +0000 Subject: [PATCH] Updated README.md --- README.md | 58 +++++++++++++++++++++++++++---------------------------- 1 file changed, 28 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 1fd3a23..bc56866 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ An svg layout designer. + # Getting Started Requirements : @@ -13,25 +14,38 @@ Requirements : - [`git-lfs`](https://git-lfs.github.com/) (in order to clone the documentation) - `dotnet` (optional) used for api test -# Developping -Run `npm ci` +# Recommanded tools for developers + +- [VSCode](https://code.visualstudio.com/) +- [React DevTools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi) +- [Typescript React code snippets](https://marketplace.visualstudio.com/items?itemName=infeng.vscode-react-typescript) +- [vscode-tailwindcss](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) +- [vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + + +# Develop + +Run `npm i` Run `npm run dev` + # Deploy -Run `npm ci` +Run `npm i` Run `npm run build` # Run the tests -Run `npm ci` +Run `npm i` Run `npm test` +Or run `npm test:full` to also test the C# API + # API @@ -40,14 +54,13 @@ 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 +node run ./test-server/http.js ``` The web server will be running at `http://localhost:5000` @@ -55,28 +68,6 @@ The web server will be running at `http://localhost:5000` Copy `.env.development` to the file `.env.development.local` and change the url to whatever you want to use. -## 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` - -Copy `.env.development` to the file `.env.development.local` -and change the url to whatever you want to use. - -# Recommanded tools - -- [VSCode](https://code.visualstudio.com/) -- [React DevTools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi) -- [Typescript React code snippets](https://marketplace.visualstudio.com/items?itemName=infeng.vscode-react-typescript) -- [vscode-tailwindcss](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) -- [vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) # Setup debugging with chrome @@ -105,14 +96,21 @@ Change the `url` to the dev server url. Set the `runtimeExecutable` to your favo # Generate definition files for SmartModeler -Pre-requisite: `typescript`, `python3` +Prerequisites: `typescript`, `python3` Go to the `src/dts` directory and run the following command +``` +npx tsc --project tsconfig.dts.json +``` + +Or if installed globally + ``` tsc --project tsconfig.dts.json ``` + Then, run `python3` (or `py` on Windows) on `generate_dts.py`: ```