From 63e06105328498ca6c6ee0c18a656d932d7f7b21 Mon Sep 17 00:00:00 2001 From: Bastien DUMONT <bdumont@grandlyon.com> Date: Thu, 9 Feb 2023 14:20:02 +0000 Subject: [PATCH] Update README.md --- README.md | 83 ++----------------------------------------------------- 1 file changed, 2 insertions(+), 81 deletions(-) diff --git a/README.md b/README.md index c587f93a..a2557edd 100644 --- a/README.md +++ b/README.md @@ -1,82 +1,3 @@ -# Client - LLLE +# Ecolyo Agent Client -Projet client du backoffice LLLE - -## Install - -In order to install the project, make sure you have installed the followings : - -- NodeJS -- Yarn -- Docker / Docker Compose -- VSCode Editor (or the one you prefer), with at least ESLint and Prettier extensions - -You can then clone the app repository and install dependencies: - -```sh -$ git clone https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-client.git -$ cd backoffice-client -yarn -``` - -## Local usage - -Before launching the application, ensure you've properly filled the **.env** file according to the .env.template. If needed please refer to a team member. - -In order to launch the projet in local with the backend working launch the following command - -```bash -yarn local-up -``` - -This command will launch the app from the _docker-compose.local.yml_ file, which will launch 3 docker images and start the react app with _yarn start_ - -- The backend Go app, from the image located on its GitLab repository -- The mongo Database, from the DockerHub image -- The Ngnix server with a local configuration located in nginx/site.conf - -To stop it properly use - -```bash -yarn local-down -``` - -This app runs in https, such as the backend, to access it go on https://localhost/ -Also make sure you have HTTPS env variable set to true. -Do not use the app with the port 3000, you won't be able to login. - -> :warning: **If you are launching the project from a Linux OS** : Make sure to uncomment the commented lines in the docker-compose.local file. Otherwise, you you won't be able to access your machine's localhost from the docker container. - -## Backend and Database - -In order to get Backend documentation, please refer directly to the [backend project](https://forge.grandlyon.com/web-et-numerique/llle_project/backoffice-server) - -## Nginx - -The nginx server redirects https requests from frontend to the backend on port 1443. - -It has two configuration files : - -- nginx/site.conf, used for local development -- nginx/site.prod.conf, used for production - -The nginx server needs local ssl certificates in order to run an interact with backend, these certificates are present in the project. - -## CI/CD - -This app has a gitlab CI/CD pipeline you can find in the _.gitlab-ci.yml_ file. -On the dev branch and on merge requests, the pipeline will run a build stage and a quality stage, which is a Sonarqube quality check. -On dev and master branches, the pipeline will run a docker image build that you can find in the GitLab container registry. - -### Editor - -This app uses Draft.js Wysiwyg editor for more information checkout its (documentation page)[https://draftjs.org/docs/getting-started] -For more advanced documentation about editor customization, please checkout the (react draft wysiwig page)[https://jpuri.github.io/react-draft-wysiwyg/#/docs?_k=jjqinp] - -### Environment Variables - -There is a template.env file in this project, however you can ask one the developpers to get a ready-to-use .env file. - -- IMAGE_FOLDER: this variable specify the folder where ecogestures images are located. By default, you can place this folder at the same level as your project for a local usage. (not inside the project). For alpha, rec/prod environment, make sure the path indicated in docker-compose volumes correspond with the location of the image file on the server. - -- MOCK_OAUTH2: Set this variable to true while in local, so the OAuth2 dance will be mocked by backend and you will be able to login to your application. +[check documentation here](https://doc.self-data.alpha.grandlyon.com/ecolyo-agent/technical/getting_started/#local-usage) -- GitLab