diff --git a/docs/pilote/Pilote - TS - Back/application/deploy.md b/docs/pilote/Pilote - TS - Back/application/deploy.md index 0ab69a0db7893fb591de6441ed4a9bba18f093e9..cf41a3fd851a0b009feb93a1c2a54042225f5088 100644 --- a/docs/pilote/Pilote - TS - Back/application/deploy.md +++ b/docs/pilote/Pilote - TS - Back/application/deploy.md @@ -1,9 +1,3 @@ -!!! info "" - :construction: Section under Construction :construction: - -This section will show you how to deploy your project on different environments. - - ### Deployment For each environment, the CI-CD is implemented. diff --git a/docs/pilote/Pilote - TS - Back/functionalities/routes.md b/docs/pilote/Pilote - TS - Back/functionalities/routes.md new file mode 100644 index 0000000000000000000000000000000000000000..ea55a4625a0a47a4bfad38d17507c0aac93e79cf --- /dev/null +++ b/docs/pilote/Pilote - TS - Back/functionalities/routes.md @@ -0,0 +1,35 @@ +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. + 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 072a887fd5aefa54640c594a6e6babd65dde3b14..942de67200e15ff491bd8cc74fc95165b2319426 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 @@ -1,8 +1,3 @@ -!!! 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 ### Clone the project repository diff --git a/docs/pilote/Pilote - TS - Back/project_architecture/Partage_SMS.png b/docs/pilote/Pilote - TS - Back/project_architecture/Partage_SMS.png new file mode 100644 index 0000000000000000000000000000000000000000..54485ef3adc73e9a9497a501b680145e623ea32a Binary files /dev/null and b/docs/pilote/Pilote - TS - Back/project_architecture/Partage_SMS.png differ diff --git a/docs/pilote/Pilote - TS - Back/project_architecture/architecture.md b/docs/pilote/Pilote - TS - Back/project_architecture/architecture.md index a0b4d59a813eb65fabfd70bf5d062a2f55bf1e35..9817c7f27171d002b5567ae6a128af2dae5a063f 100644 --- a/docs/pilote/Pilote - TS - Back/project_architecture/architecture.md +++ b/docs/pilote/Pilote - TS - Back/project_architecture/architecture.md @@ -1,13 +1,18 @@ -!!! info "" - :construction: Section under Construction :construction: - - -## Techno used +# Techno used - NestJS -- Jest for th tests +- Jest for the tests - Docker - 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 diff --git a/docs/pilote/Pilote - TS - Front/application/deploy.md b/docs/pilote/Pilote - TS - Front/application/deploy.md index 4463cf85eb16a098cbe1cc4a005d92117a40ed24..694c97dacbf16d570d30807c02100ad4ccaa09df 100644 --- a/docs/pilote/Pilote - TS - Front/application/deploy.md +++ b/docs/pilote/Pilote - TS - Front/application/deploy.md @@ -1,9 +1,3 @@ -!!! info "" - :construction: Section under Construction :construction: - -This section will show you how to deploy your project on different environments. - - ### Deployment For each environment, the CI-CD is implemented. 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 index 87fe58f37e880b8851eebc60cd55d6a5d9426254..2f01b100f993ac1c80ad0b4b0500dbaa89d6d6b2 100644 --- a/docs/pilote/Pilote - TS - Front/getting_started/launch_local_application.md +++ b/docs/pilote/Pilote - TS - Front/getting_started/launch_local_application.md @@ -1,8 +1,3 @@ -!!! 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 diff --git a/docs/pilote/Pilote - Usager/application/deploy.md b/docs/pilote/Pilote - Usager/application/deploy.md index 4fb31f7812a39224f0358a5c6f1e696cb983124f..831f08ea72d6a8f6c23c586d5e8bdb36e4904a87 100644 --- a/docs/pilote/Pilote - Usager/application/deploy.md +++ b/docs/pilote/Pilote - Usager/application/deploy.md @@ -108,8 +108,6 @@ If you want to deploy on the pilote-build environment, use : 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 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. diff --git a/docs/pilote/Pilote - Usager/application/doctypes.md b/docs/pilote/Pilote - Usager/application/doctypes.md index 087646e539ffd49bd2543e500a3bfd65fd4deaf4..dcccd052477bfa11eb3e754c554bf3dc6d511a6e 100644 --- a/docs/pilote/Pilote - Usager/application/doctypes.md +++ b/docs/pilote/Pilote - Usager/application/doctypes.md @@ -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.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.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.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 diff --git a/docs/pilote/Pilote - Usager/getting_started/launch_local_doctypes.md b/docs/pilote/Pilote - Usager/getting_started/launch_local_doctypes.md index 86fb0836c18c6f1385d381b6d77692ce2d0b65d5..b565d9567d7ad885fb53d4f5ae7e88ae0436917a 100644 --- a/docs/pilote/Pilote - Usager/getting_started/launch_local_doctypes.md +++ b/docs/pilote/Pilote - Usager/getting_started/launch_local_doctypes.md @@ -1,8 +1,3 @@ -!!! info "" - :construction: Section under Construction :construction: - - - ## 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. diff --git a/docs/pilote/Pilote - Usager/getting_started/launch_local_services.md b/docs/pilote/Pilote - Usager/getting_started/launch_local_services.md index 7220022ec9114957465da44412089b3bc0d52c89..1ad538d65050e969e999b206bda66ded9a4d0fa2 100644 --- a/docs/pilote/Pilote - Usager/getting_started/launch_local_services.md +++ b/docs/pilote/Pilote - Usager/getting_started/launch_local_services.md @@ -1,7 +1,3 @@ -!!! info "" - :construction: Section under Construction :construction: - - ### Use services in local ## Configure the cozy-stack on local In order to be able to use your sercice, follow these steps: