From 1909685158e092df617e50add9e6e655b5d23cbf Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Tue, 3 Apr 2018 08:44:04 +0200 Subject: [PATCH] Improve contributing guide --- .github/CONTRIBUTING.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c9988bfea..a58efc1dd 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -75,7 +75,7 @@ $ npm run dev:server Then, the server will listen on `localhost:9000`. When server source files change, these are automatically recompiled and the server will automatically -restart. Server is in `TEST` mode so it will run requests between instances more quickly. +restart. ### Client side @@ -93,14 +93,35 @@ The API will listen on `localhost:9000` and the frontend on `localhost:3000`. Client files are automatically compiled on change, and the web browser will reload them automatically thanks to hot module replacement. -### Test federation +### Client and server side + +The API will listen on `localhost:9000` and the frontend on `localhost:3000`. +File changes are automatically recompiled, injected in the web browser (no need to refresh manually) +and the web server is automatically restarted. + +``` +$ npm run dev +``` + +### Federation This will run 3 nodes: ``` +$ npm run build $ npm run clean:server:test $ npm run play ``` Then you will get access to the three nodes at `http://localhost:900{1,2,3}` with the `root` as username and `test{1,2,3}` for the password. + + +### Unit tests + +To run unit tests, you need to build the application first: + +``` +$ npm run build +$ npm test +```