refs #5739 feat: init.sh refactor(readme): add new commands

README.md

@@ -8,44 +8,69 @@ Salix is also the scientific name of a beautifull tree! :)
 
 Required applications.
 
-* Node.js
 * Docker
 * Git
 
-You will need to install globally the following items.
+Optional.
-```
+
-$ sudo npm install -g jest gulp-cli
+- NodeJS
-```
+
+
+## Directory structure recommendation
+- /Salix
+    - /back ← this project
+    - /front ← salix-front project
 
 ## Installing dependencies and launching
 
 Pull from repository.
+```sh
+$ git clone [url] [directory]
+```
 
 Run this commands on project root directory to install Node dependencies.
-```
+```sh
-$ npm install
+$ sh init.sh
-$ gulp install
 ```
 
 Launch application in developer environment.
+```sh
+$ docker compose -f docker-compose.local.yml up
 ```
-$ gulp
+
+With NodeJS
+```sh
+$ npm run start
 ```
 
 Manually reset fixtures.
-```
+```sh
-$ gulp docker
+$ docker compose -f docker-compose.local.yml up --build
 ```
 
+With NodeJS
+```sh
+$ npm run restart
+```
 ## Running the unit tests
 
 For client-side unit tests run from project's root.
+```sh
+$ sh runTestFront.sh
 ```
+
+With NodeJS
+```sh
 $ npm run test:front
 ```
 
 For server-side unit tests run from project's root.
+```sh
+$ sh runTestBack.sh
 ```
+
+With NodeJS
+```sh
 $ npm run test:back
 ```
 

init.sh

@@ -2,6 +2,6 @@ sudo docker run --rm -it \
     -w /salix \
     -v $PWD/../salix:/salix \
     node:20-bullseye \
-    npm i -g  gulp-cli \
+    npm i -g  gulp-cli && \
-    npm i \
+    npm i && \
     gulp i