Skip to content
Snippets Groups Projects
Commit dd31e708 authored by Bastien DUMONT's avatar Bastien DUMONT :angel:
Browse files

fix(pilote): update installation doc

parent b8a8e6d5
Branches
Tags
No related merge requests found
Pipeline #32866 failed
...@@ -12,10 +12,13 @@ git clone https://forge.grandlyon.com/solidarite/monparcourssocial/mps-travaille ...@@ -12,10 +12,13 @@ git clone https://forge.grandlyon.com/solidarite/monparcourssocial/mps-travaille
### Start Pilote application ### 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: If the application starts successfully you should obtain two containers running:
......
...@@ -15,10 +15,12 @@ git clone https://forge.grandlyon.com/solidarite/monparcourssocial/mps-travaille ...@@ -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: 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 yarn start
...@@ -26,5 +28,5 @@ yarn start ...@@ -26,5 +28,5 @@ yarn start
If the application starts successfully you should access to: If the application starts successfully you should access to:
> http://localhost:3001/ > [http://localhost:4200/](http://localhost:4200/)
...@@ -15,7 +15,7 @@ git clone https://forge.grandlyon.com/solidarite/monparcourssocial/mps-usager ...@@ -15,7 +15,7 @@ git clone https://forge.grandlyon.com/solidarite/monparcourssocial/mps-usager
Before starting Pilote Usager application, you need to install dependencies: 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: 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 ...@@ -33,7 +33,7 @@ As the pilote application has been recently upgraded to NodeJS 16 version, you m
- node-gyp - node-gyp
And wait for the success message. 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**'. Once successful you can launch your local cozy with following url [Cozy local url](http://cozy.tools:8080/) and connect with the password '**cozy**'.
......
...@@ -9,13 +9,19 @@ Pilote aims to help people in various administrative processes, allowing them to ...@@ -9,13 +9,19 @@ Pilote aims to help people in various administrative processes, allowing them to
## ![gitlab](../img/gitlab-logo.svg) Repositories ## ![gitlab](../img/gitlab-logo.svg) Repositories
- [global](https://forge.grandlyon.com/solidarite/monparcourssocial) [MPS group](https://forge.grandlyon.com/solidarite/monparcourssocial) contains the following repos:
- [backend travailleur social](https://forge.grandlyon.com/solidarite/monparcourssocial/mps-travailleursocial-back)
- [front usager](https://forge.grandlyon.com/solidarite/monparcourssocial/mps-travailleursocial) * [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 ## Acces to the application deployed
- DEV : https://pilote-agent-dev.grandlyon.com/ - DEV : [https://pilote-agent-dev.grandlyon.com/](https://pilote-agent-dev.grandlyon.com/)
- REC : https://pilote-agent-rec.grandlyon.com/ - REC : [https://pilote-agent-rec.grandlyon.com/](https://pilote-agent-rec.grandlyon.com/)
- PROD : https://pilote-agent.grandlyon.com/ - PROD : [https://pilote-agent.grandlyon.com/](https://pilote-agent.grandlyon.com/)
...@@ -19,7 +19,6 @@ Here are the list of important extensions to install: ...@@ -19,7 +19,6 @@ Here are the list of important extensions to install:
Optional extensions: Optional extensions:
- Bracket Pair Colorizer 2
- CSS Peek - CSS Peek
- Auto Rename Tag - Auto Rename Tag
- indent-rainbow - indent-rainbow
...@@ -28,7 +27,41 @@ Optional extensions: ...@@ -28,7 +27,41 @@ Optional extensions:
### User settings ### 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 ## Git
...@@ -36,12 +69,11 @@ The project is using GitLab, you will need to install Git to checkout the projec ...@@ -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/). Installation for Git can be found here: [Installation of Git](https://git-scm.com/).
## Node ## Node
Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
!!! warning "Version 12" !!! warning "Version 14 & 16"
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)
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 ## Yarn
......
...@@ -44,6 +44,7 @@ nav: ...@@ -44,6 +44,7 @@ nav:
- Home: - Home:
- Getting started: index.md - Getting started: index.md
- Additional Ressources: external_doc.md - Additional Ressources: external_doc.md
- Setup your environment: setup_your_environment.md
- Easy Cozy: - Easy Cozy:
- Introduction: easycozy/index.md - Introduction: easycozy/index.md
- Configuration: easycozy/config.md - Configuration: easycozy/config.md
...@@ -113,7 +114,6 @@ nav: ...@@ -113,7 +114,6 @@ nav:
- Routes: pilote/Pilote - TS - Back/functionalities/routes.md - Routes: pilote/Pilote - TS - Back/functionalities/routes.md
- Getting Started: - Getting Started:
- Launch the application on local: pilote/Pilote - TS - Back/getting_started/launch_local_application.md - 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 - Project Architecture: pilote/Pilote - TS - Back/project_architecture/architecture.md
- Pilote - TS - Front: - Pilote - TS - Front:
- Application: - Application:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment