diff --git a/docs/pilote/Pilote - TS - Back/application/deploy.md b/docs/pilote/Pilote - TS - Back/application/deploy.md index 4463cf85eb16a098cbe1cc4a005d92117a40ed24..0ab69a0db7893fb591de6441ed4a9bba18f093e9 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 77f2b9cce22413c532f36450b50145b8c60bfe01..072a887fd5aefa54640c594a6e6babd65dde3b14 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 692a3e5ed7b3f000ddbc2cc4e6f84cad62f654e1..e26520032668898550546682eaf0f68ec41b0162 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 748bc4dbecccda25be68c5056cad1a87cf1f54b8..60729ec5114ebf0d929e6a9f6db4ce5a263b063f 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 7e05fd01eaaa1489442d0cd58bb145997296e638..a0b4d59a813eb65fabfd70bf5d062a2f55bf1e35 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 0000000000000000000000000000000000000000..87fe58f37e880b8851eebc60cd55d6a5d9426254 --- /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/ +