This app is deployed on an Openshift cluster provided by Synaaps, all instructions for authentification and deployment are given [here](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-server/-/blob/dev/k8s/README.md)
## CICD
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.
On dev and master branches, the pipeline will run a docker image build that you can find in the GitLab container registry.
## Alpha usage
In order to test the app on alpha you can do the following steps:
- Build locally your docker image for the client and/or the server
[Ecolyo-Agent Server repository](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-server)
## Local usage
### Installation of the project
!!! note
Before launching the application, ensure you've properly filled the `.env` file according to the template. If needed please refer to a team member. The template contains
To install required node modules, open a terminal on the root folder of the backoffice-client project and type the following command:
```sh
yarn install
```
Before launching the application, ensure you've properly filled the `.env` file according to the template. If needed please refer to a team member.
- 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.
In order to launch the project in local with the backend working launch the following command
...
...
@@ -31,40 +27,32 @@ In order to launch the project in local with the backend working launch the foll
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_
This command will launch the app from the _docker-compose.local.yml_ file, which will launch 4 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
- A mySQL database, from the DockerHub image
- A phpMyAdmin to browse the database, from the DockerHub image
- The Nginx server with a local configuration located in nginx/site.conf
To stop it properly use
```bash
yarn local-down
```
???note "Nginx info"
The nginx server redirects https requests from front-end to the backend on port 1443.
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.
It has two configuration files :
> :warning: **If you are launching the project from a Windows OS** : Make sure to comment the 'extra_hosts' lines in the docker-compose.local file. Otherwise, you you won't be able to access your machine's localhost from the docker container.
- `nginx/site.conf`, used for local development
- `nginx/site.prod.conf`, used for production
#### Backend and Database
The nginx server needs local ssl certificates in order to run an interact with backend, these certificates are present in the project.
In order to get Backend documentation, please refer directly to the [backend readme](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-server/-/blob/dev/README.md)
#### Nginx
The nginx server redirects https requests from front-end 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
To stop it properly use
The nginx server needs local ssl certificates in order to run an interact with backend, these certificates are present in the project.
```bash
yarn local-down
```
#### Check success
??? note "for windows users"
:warning: **If you are launching the project from a Windows OS** : Make sure to comment the 'extra_hosts' lines in the docker-compose.local file. Otherwise, you you won't be able to access your machine's localhost from the docker container.
To check if the application starts successfully, launch the command
...
...
@@ -80,64 +68,42 @@ You should obtain the following messages:
Once the application is started, you can access it at <https://localhost>
## Alpha usage
!!! tip
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.
In order to test the app on alpha you can do the following steps:
## Ecolyo Agent - Server
- Build locally your docker image for the client and/or the server
