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

add Pilote documentation

parent 0789f8a6
No related branches found
No related tags found
No related merge requests found
Pipeline #12057 passed
Showing
with 46 additions and 40 deletions
!!! info ""
:construction: Section under Construction :construction:
This section will show you how to deploy your project on different environments.
### Deployment ### Deployment
For each environment, the CI-CD is implemented. For each environment, the CI-CD is implemented.
......
This section explains the different API route.
# Auth
- `api/auth/signin`: It is used for local and dev authentification. It is linked to two different password into the database.
- `api/auth/token` : It is used for generate one token. Only for internal process. This route is not call from another apps.
- `api/auth/token/check`: It is used for check one token. It is called from cozy-stack service of the usager.
- `api/auth/token`: It is used for generate one token. Only for internal process. This route is not call from another apps.
- `api/auth/login`: It is used for Sign&Go authentification. Linked to AuthStrategy.
- `login/callback`: Get the authentification from Sign&Go process.
# Beneficiary
- `/api/beneficiaire`: Get all usager known from Postgre database.
- `/api/beneficiaire/create'`: This rotue is used in order to store Usager domain and his trigger proccess from Cozy.
# Cozy
- `api/redirect/cozy`: Allow to send information to the cozy-stack in order to run smsProccess on cozy-stask side.
# Users
Authentification only used for local or dev environment because Sign&Go is only available for rec and prod env.
!!! info ""
:construction: Section under Construction :construction:
This section will allow you to launch a proper local environment of the Pilote TS back application
## Initialisation of the project ## Initialisation of the project
### Clone the project repository ### Clone the project repository
......
docs/pilote/Pilote - TS - Back/project_architecture/Partage_SMS.png

163 KiB

!!! info "" # Techno used
:construction: Section under Construction :construction:
## Techno used
- NestJS - NestJS
- Jest for th tests - Jest for the tests
- Docker - Docker
- PostgreSQL - PostgreSQL
# Docker-compose
Two docker-compose are available into the project:
- the general one
- the local one
For the general one, all service are details. The env variable used are available on Synapps server.
The local one is used with the docker-compose_dev.yml
\ No newline at end of file
!!! info ""
:construction: Section under Construction :construction:
This section will show you how to deploy your project on different environments.
### Deployment ### Deployment
For each environment, the CI-CD is implemented. For each environment, the CI-CD is implemented.
......
!!! 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 ## Initialisation of the project
### Clone the project repository ### Clone the project repository
......
...@@ -108,8 +108,6 @@ If you want to deploy on the pilote-build environment, use : ...@@ -108,8 +108,6 @@ If you want to deploy on the pilote-build environment, use :
yarn deploy yarn deploy
``` ```
To deploy on the llle-build environment, you'll have to drag and drop your build folder directly in llle-build using MobaXterm.
#### Linux #### Linux
From your current branch, run ```yarn build``` then ```sudo yarn deploy_dev``` to instantly deploy your working branch on the latest tagged Pilote container registry. From your current branch, run ```yarn build``` then ```sudo yarn deploy_dev``` to instantly deploy your working branch on the latest tagged Pilote container registry.
...@@ -14,7 +14,6 @@ The following is a full description of the doctypes we use and their fields. Coz ...@@ -14,7 +14,6 @@ The following is a full description of the doctypes we use and their fields. Coz
- [`io.cozy.contacts`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.contacts): Contacts - [`io.cozy.contacts`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.contacts): Contacts
- [`io.cozy.contacts.groups`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.contacts.groups): Contacts groups - [`io.cozy.contacts.groups`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.contacts.groups): Contacts groups
- [`io.cozy.files`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.files): Files - [`io.cozy.files`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.files): Files
- [`io.cozy.konnectors`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.konnectors): Connectors installed in the cozy
- [`io.cozy.permissions`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.permissions): Permissions of the instance - [`io.cozy.permissions`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.permissions): Permissions of the instance
- [`io.cozy.todos.item`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.todos.item): Todos item - [`io.cozy.todos.item`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.todos.item): Todos item
- [`io.cozy.todos.list`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.todos.list): Todos list - [`io.cozy.todos.list`](https://docs.cozy.io/en/cozy-doctypes/docs/io.cozy.todos.list): Todos list
......
!!! info ""
:construction: Section under Construction :construction:
## Use cozy-doctype in local ## Use cozy-doctype in local
In order to be able to use our own cozy-doctype, especialy remote doctype here, we need to use them in local. In order to be able to use our own cozy-doctype, especialy remote doctype here, we need to use them in local.
......
!!! info ""
:construction: Section under Construction :construction:
### Use services in local ### Use services in local
## Configure the cozy-stack on local ## Configure the cozy-stack on local
In order to be able to use your sercice, follow these steps: In order to be able to use your sercice, follow these steps:
......
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