aboutsummaryrefslogtreecommitdiffhomepage
path: root/.github
diff options
context:
space:
mode:
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md25
1 files 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
75 75
76Then, the server will listen on `localhost:9000`. When server source files 76Then, the server will listen on `localhost:9000`. When server source files
77change, these are automatically recompiled and the server will automatically 77change, these are automatically recompiled and the server will automatically
78restart. Server is in `TEST` mode so it will run requests between instances more quickly. 78restart.
79 79
80### Client side 80### Client side
81 81
@@ -93,14 +93,35 @@ The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
93Client files are automatically compiled on change, and the web browser will 93Client files are automatically compiled on change, and the web browser will
94reload them automatically thanks to hot module replacement. 94reload them automatically thanks to hot module replacement.
95 95
96### Test federation 96### Client and server side
97
98The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
99File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
100and the web server is automatically restarted.
101
102```
103$ npm run dev
104```
105
106### Federation
97 107
98This will run 3 nodes: 108This will run 3 nodes:
99 109
100``` 110```
111$ npm run build
101$ npm run clean:server:test 112$ npm run clean:server:test
102$ npm run play 113$ npm run play
103``` 114```
104 115
105Then you will get access to the three nodes at `http://localhost:900{1,2,3}` 116Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
106with the `root` as username and `test{1,2,3}` for the password. 117with the `root` as username and `test{1,2,3}` for the password.
118
119
120### Unit tests
121
122To run unit tests, you need to build the application first:
123
124```
125$ npm run build
126$ npm test
127```