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 1de15b0a7921d9c804e41e40c06bd2e1a2ba02f8..ccd891cd6fa8d1f245267b87685e2036dd527d24 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 @@ -12,10 +12,13 @@ git clone https://forge.grandlyon.com/solidarite/monparcourssocial/mps-travaille ### Start Pilote application -To start Pilote application just launch the command in a Powershell or Windows Powershell tool: +Copy the ```template.env``` into ```.env``` + +To start Pilote application just launch the following command in a terminal : ``` -yarn docker:dev +yarn +docker-compose -f docker-compose.dev.yml up -d ``` If the application starts successfully you should obtain two containers running: 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 3b9db5ba4c6365cfae485214f8cbb54ede343d05..69beb3ef62832a3cc4270b079aabe84848301925 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 @@ -15,10 +15,12 @@ git clone https://forge.grandlyon.com/solidarite/monparcourssocial/mps-travaille Before to start Pilote application, you need to run this command in order to install dependencies: ``` -yarn install +yarn ``` -To start Pilote application just launch the command in a Powershell or Windows Powershell tool: +Copy the ```template.env``` into ```.env``` + +To start Pilote application, make sure the server is running and launch the command in a terminal : ``` yarn start @@ -26,5 +28,5 @@ yarn start If the application starts successfully you should access to: -> http://localhost:3001/ +> [http://localhost:4200/](http://localhost:4200/) diff --git a/docs/pilote/Pilote - Usager/getting_started/launch_local_application.md b/docs/pilote/Pilote - Usager/getting_started/launch_local_application.md index d422c9e02dcdf495933b55048724c2ef0d02b2bd..d5d792d5f2be31fbf63cd770e9484df4191d1bb6 100644 --- a/docs/pilote/Pilote - Usager/getting_started/launch_local_application.md +++ b/docs/pilote/Pilote - Usager/getting_started/launch_local_application.md @@ -15,7 +15,7 @@ git clone https://forge.grandlyon.com/solidarite/monparcourssocial/mps-usager Before starting Pilote Usager application, you need to install dependencies: ``` -yarn install +yarn ``` To start Pilote Usager application, you first need start the application and start a cozy stack: @@ -33,7 +33,7 @@ As the pilote application has been recently upgraded to NodeJS 16 version, you m - node-gyp And wait for the success message. -> Everything is setup. Go to http://pilote.cozy.tools:8080/ +> Everything is setup. Go to [http://pilote.cozy.tools:8080/](http://pilote.cozy.tools:8080/) Once successful you can launch your local cozy with following url [Cozy local url](http://cozy.tools:8080/) and connect with the password '**cozy**'. diff --git a/docs/pilote/index.md b/docs/pilote/index.md index 9d07c190a102b98636533080792589b4f196357c..93f375908f455c156dbd1853a57ff504b43c7b8c 100644 --- a/docs/pilote/index.md +++ b/docs/pilote/index.md @@ -9,13 +9,19 @@ Pilote aims to help people in various administrative processes, allowing them to ##  Repositories -- [global](https://forge.grandlyon.com/solidarite/monparcourssocial) -- [backend travailleur social](https://forge.grandlyon.com/solidarite/monparcourssocial/mps-travailleursocial-back) -- [front usager](https://forge.grandlyon.com/solidarite/monparcourssocial/mps-travailleursocial) +[MPS group](https://forge.grandlyon.com/solidarite/monparcourssocial) contains the following repos: + +* [pilote usager](https://forge.grandlyon.com/solidarite/monparcourssocial/mps-usager) +* travailleur social + * [backend](https://forge.grandlyon.com/solidarite/monparcourssocial/mps-travailleursocial-back) + * [frontend](https://forge.grandlyon.com/solidarite/monparcourssocial/mps-travailleursocial) + +## Requirements +Node **16** ## Acces to the application deployed -- DEV : https://pilote-agent-dev.grandlyon.com/ -- REC : https://pilote-agent-rec.grandlyon.com/ -- PROD : https://pilote-agent.grandlyon.com/ +- DEV : [https://pilote-agent-dev.grandlyon.com/](https://pilote-agent-dev.grandlyon.com/) +- REC : [https://pilote-agent-rec.grandlyon.com/](https://pilote-agent-rec.grandlyon.com/) +- PROD : [https://pilote-agent.grandlyon.com/](https://pilote-agent.grandlyon.com/) diff --git a/docs/pilote/Pilote - TS - Back/getting_started/setup_your_environment.md b/docs/setup_your_environment.md similarity index 64% rename from docs/pilote/Pilote - TS - Back/getting_started/setup_your_environment.md rename to docs/setup_your_environment.md index d93694806429ce79160f6536ea1c482ebe863580..401cff07d268f0e0a0ca243d0791a8b192aa7b5d 100644 --- a/docs/pilote/Pilote - TS - Back/getting_started/setup_your_environment.md +++ b/docs/setup_your_environment.md @@ -19,7 +19,6 @@ Here are the list of important extensions to install: Optional extensions: -- Bracket Pair Colorizer 2 - CSS Peek - Auto Rename Tag - indent-rainbow @@ -28,7 +27,41 @@ Optional extensions: ### User settings -User settings for Ecolyo are described in this section: **LINK TO SECTION TO ADD** +Open the project with VSCode and add the following code into .vscode/settings.json: + +``` +{ + "workbench.colorCustomizations": { + /* Put anything you like here */ + }, + "editor.snippetSuggestions": "top", + "editor.tabSize": 2, + "editor.formatOnSave": true, + "diffEditor.ignoreTrimWhitespace": false, + "window.zoomLevel": 0, + "gitlens.advanced.messages": { + "suppressShowKeyBindingsNotice": true + }, + "breadcrumbs.enabled": true, + "workbench.settings.editor": "json", + "editor.tabSize": 2, + "editor.formatOnSave": true, + "editor.formatOnPaste": true +} +``` + +If this file is not empty, you can simply add the following lines to it: + +``` + "gitlens.advanced.messages": { + "suppressShowKeyBindingsNotice": true + }, + "breadcrumbs.enabled": true, + "workbench.settings.editor": "json", + "editor.formatOnSave": true, + "diffEditor.ignoreTrimWhitespace": false, + "window.zoomLevel": 0, +``` ## Git @@ -36,12 +69,11 @@ The project is using GitLab, you will need to install Git to checkout the projec Installation for Git can be found here: [Installation of Git](https://git-scm.com/). ## Node +Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine. -!!! warning "Version 12" -For now please install node v12, any later version will cause side effects on sass modules! -Download [node-v12](https://nodejs.org/download/release/v12.19.0/node-v12.19.0-x64.msi) +!!! warning "Version 14 & 16" -Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine. +For our projects you will need to have a version manager for node such as [**n**](https://www.npmjs.com/package/n) on linux and [**nvm**](https://github.com/coreybutler/nvm-windows) on windows. Install both 14 and 16 versions. ## Yarn diff --git a/mkdocs.yml b/mkdocs.yml index e7be01c6fe687cd0d883cb543b38dcdfab223eb1..550e75ce1c98862d61806926561323614f82bef9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -44,6 +44,7 @@ nav: - Home: - Getting started: index.md - Additional Ressources: external_doc.md + - Setup your environment: setup_your_environment.md - Easy Cozy: - Introduction: easycozy/index.md - Configuration: easycozy/config.md @@ -113,7 +114,6 @@ nav: - Routes: pilote/Pilote - TS - Back/functionalities/routes.md - Getting Started: - Launch the application on local: pilote/Pilote - TS - Back/getting_started/launch_local_application.md - - Setup your environment: pilote/Pilote - TS - Back/getting_started/setup_your_environment.md - Project Architecture: pilote/Pilote - TS - Back/project_architecture/architecture.md - Pilote - TS - Front: - Application: