Skip to content
Snippets Groups Projects
Commit 5b126254 authored by PEDROLI Benjamin's avatar PEDROLI Benjamin
Browse files

add additional documentation for Pilote app

parent 7dea4406
No related branches found
No related tags found
No related merge requests found
......@@ -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
......@@ -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
......
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
......
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/
......@@ -4,8 +4,10 @@
## Techno used
> NestJS
> Jest for th tests
> Docker
> PostgreSQL
- NestJS
- Jest for th tests
- Docker
- PostgreSQL
!!! 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/
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment