From 5b12625451e2fbf16f87de4a0c1478f1eaffb6b9 Mon Sep 17 00:00:00 2001
From: PEDROLI Benjamin <benjamin.pedroli@soprasteria.com>
Date: Mon, 28 Dec 2020 09:46:46 +0100
Subject: [PATCH]  add additional documentation for Pilote app

---
 .../Pilote - TS - Back/application/deploy.md  |  2 +-
 .../launch_local_application.md               |  8 +++--
 .../getting_started/setup_your_environment.md |  2 +-
 docs/pilote/Pilote - TS - Back/index.md       |  7 ++--
 .../project_architecture/architecture.md      | 10 +++---
 .../launch_local_application.md               | 35 +++++++++++++++++++
 6 files changed, 52 insertions(+), 12 deletions(-)
 create mode 100644 docs/pilote/Pilote - TS - Front/getting_started/launch_local_application.md

diff --git a/docs/pilote/Pilote - TS - Back/application/deploy.md b/docs/pilote/Pilote - TS - Back/application/deploy.md
index 4463cf8..0ab69a0 100644
--- a/docs/pilote/Pilote - TS - Back/application/deploy.md	
+++ b/docs/pilote/Pilote - TS - Back/application/deploy.md	
@@ -8,4 +8,4 @@ This section will show you how to deploy your project on different environments.
 
 For each environment, the CI-CD is implemented. 
 
-Once, you commit on 'dev' branch or 'rec' branch, the pipeline liked is running.
\ No newline at end of file
+Once, you commit on 'dev' branch or 'rec' branch, the pipeline linked is running.
\ No newline at end of file
diff --git a/docs/pilote/Pilote - TS - Back/getting_started/launch_local_application.md b/docs/pilote/Pilote - TS - Back/getting_started/launch_local_application.md
index 77f2b9c..072a887 100644
--- a/docs/pilote/Pilote - TS - Back/getting_started/launch_local_application.md	
+++ b/docs/pilote/Pilote - TS - Back/getting_started/launch_local_application.md	
@@ -25,8 +25,10 @@ yarn docker:dev
 
 If the application starts successfully you should obtain two containers running:
 
-> mps-travailleursocial-back_mps_1
-> mps-travailleursocial-back_postgres_1
+```
+ mps-travailleursocial-back_mps_1
+ mps-travailleursocial-back_postgres_1
+```
 
 You can access by: http://localhost:3020/api 
 
@@ -35,7 +37,7 @@ It will be redirect to the Swagger UI. It allow to test the different API define
 
 ### Run Jest test 
 
-To start test defined just launch the command in a PowerShell or Windows Powershell tool:
+To start test defined just run the command in a PowerShell or Windows Powershell tool:
 
 ```
 yarn test:watch
diff --git a/docs/pilote/Pilote - TS - Back/getting_started/setup_your_environment.md b/docs/pilote/Pilote - TS - Back/getting_started/setup_your_environment.md
index 692a3e5..e265200 100644
--- a/docs/pilote/Pilote - TS - Back/getting_started/setup_your_environment.md	
+++ b/docs/pilote/Pilote - TS - Back/getting_started/setup_your_environment.md	
@@ -1,4 +1,4 @@
-This section will allow you to install a proper local environment step by step for Ecolyo application using VSCode IDE.
+This section will allow you to install a proper local environment step by step for Pilote application using VSCode IDE.
 
 ## VSCode
 
diff --git a/docs/pilote/Pilote - TS - Back/index.md b/docs/pilote/Pilote - TS - Back/index.md
index 748bc4d..60729ec 100644
--- a/docs/pilote/Pilote - TS - Back/index.md	
+++ b/docs/pilote/Pilote - TS - Back/index.md	
@@ -1,6 +1,7 @@
 Pilote is a social application.
 
-
+!!! info ""
+    :construction: Section under Construction :construction:
 
 ## Repository Global
 
@@ -12,6 +13,6 @@ Pilote is a social application.
 
 ## Acces to the application deployed
 
-DEV : https://pilote-agent-dev.grandlyon.com/
-REC : https://pilote-agent-rec.grandlyon.com/ 
+- DEV : https://pilote-agent-dev.grandlyon.com/
+- REC : https://pilote-agent-rec.grandlyon.com/ 
 
diff --git a/docs/pilote/Pilote - TS - Back/project_architecture/architecture.md b/docs/pilote/Pilote - TS - Back/project_architecture/architecture.md
index 7e05fd0..a0b4d59 100644
--- a/docs/pilote/Pilote - TS - Back/project_architecture/architecture.md	
+++ b/docs/pilote/Pilote - TS - Back/project_architecture/architecture.md	
@@ -4,8 +4,10 @@
 
 ## Techno used
 
-> NestJS 
-> Jest for th tests
-> Docker 
-> PostgreSQL
+- NestJS 
+- Jest for th tests
+- Docker 
+- PostgreSQL
+
+
 
diff --git a/docs/pilote/Pilote - TS - Front/getting_started/launch_local_application.md b/docs/pilote/Pilote - TS - Front/getting_started/launch_local_application.md
new file mode 100644
index 0000000..87fe58f
--- /dev/null
+++ b/docs/pilote/Pilote - TS - Front/getting_started/launch_local_application.md	
@@ -0,0 +1,35 @@
+!!! info ""
+:construction: Section under Construction :construction:
+
+This section will allow you to launch a proper local environment of the Pilote TS front application
+
+## Initialisation of the project
+
+### Clone the project repository
+
+Use following command in your favorite terminal to clone the projet:
+
+```
+git clone https://forge.grandlyon.com/solidarite/monparcourssocial/mps-travailleursocial.git
+```
+
+## Installation of the projet
+
+### Start Pilote application
+
+Before to start Pilote application, you need to run this command in order to install dependencies:
+
+```
+yarn install
+```
+
+To start Pilote application just launch the command in a PowerShell or Windows Powershell tool:
+
+```
+yarn start
+```
+
+If the application starts successfully you should access to:
+
+> http://localhost:3001/
+
-- 
GitLab