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

feat: update doc with /technical and /functionalities

parent 9ec24fb5
No related branches found
No related tags found
1 merge request!19Resolve "Mise à jour de la documentation"
Showing
with 87 additions and 36 deletions
{ {
"cSpell.language": "fr,en", "cSpell.language": "fr,en",
"cSpell.words": [ "cSpell.words": [
"Adict",
"backoffice", "backoffice",
"cicd", "cicd",
"cozycloud", "cozycloud",
...@@ -19,12 +20,15 @@ ...@@ -19,12 +20,15 @@
"enedis", "enedis",
"Enedis", "Enedis",
"fluidtype", "fluidtype",
"gitflow",
"Gitflow", "Gitflow",
"gitlab", "gitlab",
"grandlyon", "grandlyon",
"grdf", "grdf",
"Grdf", "Grdf",
"grdfadict",
"grdlyon", "grdlyon",
"halfhour",
"konnector", "konnector",
"konnectors", "konnectors",
"l'ecogeste", "l'ecogeste",
......
# Custom Popup
The custom popup feature sends a custom message to every instance. This message is displayed once a day. This setting can be set in the settings tab of Ecolyo agent.
It can be customized with :
- a toggle
- a title
- a description (250char max)
- a duration
If a message is active, the duration is displayed in this page ex :
"Temps d'activation restant :
0 jour, 1 heure, 59 minutes, 0 seconde"
# Newsletter
The goal is to send newsletters following this design :
![Architecture principles](/img/ecolyo-agent/newsletter-template.png)
There are 4 different sections :
- subject : manages the mail subject
- monthlyInfo : contains a image URL and some global information
- monthlyNews : contains an editable title and some information about the novelties
- poll : contains a question and a link to answer a survey
\ No newline at end of file
# Partners issues
This section allow the admin to activate alerts in the ecolyo app when a partners API is down.
Admin has to activate the modal switch AND at least one fluid switch to make it work. He also has to set the switches to off position manually when the concerned APIs are back to normal.
# Introduction # Prices
## Newsletter This section manages the prices for each fluid in the ecolyo application.
The goal is to send newsletters following this design : ## Rules
![Architecture principles](/img/ecolyo-agent/newsletter-template.png) - The next price to create is automatically pre-selected by default
- Only the 2 last prices plus the one to create are editable, the others are just searchable
There are 4 different sections : - Each fluid has its own date frequency :
- Electricity : one new price every 6 month (February and August)
- subject : manages the mail subject - Water : one new price every year
- Gas : one new price every month
- monthlyInfo : contains a image URL and some global information - When user creates a new price, the previous price's endDate is set to the new startDate minus 1 minute, so every prices keeps following in time.
- monthlyNews : contains an editable title and some information about the novelties
- poll : contains a question and a link to answer a survey
## Partners issues
This section allow the admin to activate alerts in the ecolyo app when a partners API is down.
Admin has to activate the modal switch AND at least one fluid switch to make it work. He also has to set the switches to off position manually when the concerned APIs are back to normal
## Prices
This section manages the prices for each fluid in the ecolyo application.
### Rules
- The next price to create is automatically pre-selected by default
- Only the 2 last prices plus the one to create are editable, the others are just searchable
- Each fluid has its own date frequency :
- Electricity : one new price every 6 month (February and August)
- Water : one new price every year
- Gas : one new price every month
- When user creates a new price, the previous price's endDate is set to the new startDate minus 1 minute, so every prices keeps following in time.
# Ecolyo Agent
Ecolyo-Agent is a backoffice for the Ecolyo instances. It allows multiples features described in the functionalities folder.
## Links
- [Ecolyo Agent Recette](https://ecolyo-agent-rec.apps.grandlyon.com/login)
- [Ecolyo Agent](https://ecolyo-agent.apps.grandlyon.com/login)
# Routes # API Routes
:warning: WIP :warning: :warning: WIP :warning:
......
# Deploy # Deploy Ecolyo-Agent application
This section will allow you to properly deploy Ecolyo-Agent in a production environment This section will allow you to properly deploy Ecolyo-Agent in a production environment
## Deploy Ecolyo-Agent application ## Files
To deploy ecolyo-agent application in a production environment, you need to create docker-compose.yml, site.conf and .env files To deploy ecolyo-agent application in a production environment, you need the following files :
### docker-compose.yml ### docker-compose.yml
......
# Launch Ecoylo Agent # Getting started with Ecolyo Agent
This section will allow you to launch a proper local environment for Ecolyo-Agent This section will allow you to launch a proper local environment for Ecolyo-Agent
## Local usage !!! info ""
If you are a new developer tasked to work on this project, check the [setup your environment](../../setup_your_environment.md).
### Initialisation of the project ## ![gitlab](../../img/gitlab-logo.svg) Repositories
Clone the projects using thefollowing commands This project is split between a backend and frontend, each project has its own repository.
```sh [Ecolyo-Agent front-end gitlab repository](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-client)
git clone https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-client
git clone https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-server [Ecolyo-Agent backend gitlab repository](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-server)
```
## Local usage
### Installation of the project ### Installation of the project
......
# Ecolyo Agent
Ecolyo-Agent is a backoffice for the Ecolyo app that allows to create and edit content for the newsletters sent to the users.
## Links
- [Ecolyo Agent Recette](https://ecolyo-agent-rec.apps.grandlyon.com/login)
- [Ecolyo Agent](https://ecolyo-agent.apps.grandlyon.com/login)
## ![gitlab](../../img/gitlab-logo.svg) Repositories
This project is split between a backend and frontend; each project has its own repository.
!!! info ""
If you are a new developer tasked to work on this project, check the [setup your environment](../../setup_your_environment.md) and [launch the application on local](./getting_started/launch_local_application.md) to start the application.
[Ecolyo-Agent front-end gitlab repository](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-client)
[Ecolyo-Agent backend gitlab repository](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-server)
# Ecolyo PWA
A Progressive Web App is a web application that can be installed on particular devices. It creates a shortcut of the app. The application can also be used in a webview but separated from the base navigator.
See [browser support for PWA](https://en.wikipedia.org/wiki/Progressive_web_app#Browser_support)
...@@ -9,6 +9,14 @@ This is a [Cozy](https://docs.cozy.io/en/) application that allows users to conn ...@@ -9,6 +9,14 @@ This is a [Cozy](https://docs.cozy.io/en/) application that allows users to conn
!!! danger "Reminder" !!! danger "Reminder"
If you're a new developer tasked to work on this project, please get acquainted with the team [processes](https://forge.grandlyon.com/web-et-numerique/factory/wiki_web_num) and read the advised [dev environment](https://forge.grandlyon.com/web-et-numerique/factory/wiki_web_num) documentation and the self-data [prerequisites](../index.md#installing-prerequisites). If you're a new developer tasked to work on this project, please get acquainted with the team [processes](https://forge.grandlyon.com/web-et-numerique/factory/wiki_web_num) and read the advised [dev environment](https://forge.grandlyon.com/web-et-numerique/factory/wiki_web_num) documentation and the self-data [prerequisites](../index.md#installing-prerequisites).
## [Ecolyo.com](ecolyo.com)
Ecolyo has a public landing page that showcases features.
## Konnectors
Ecolyo heavily rely on konnectors to work, check our [konnector documentation](../konnectors/index.md).
## ![gitlab](../img/gitlab-logo.svg) Repositories ## ![gitlab](../img/gitlab-logo.svg) Repositories
- [Ecolyo](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo) - [Ecolyo](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/ecolyo)
...@@ -16,7 +24,3 @@ This is a [Cozy](https://docs.cozy.io/en/) application that allows users to conn ...@@ -16,7 +24,3 @@ This is a [Cozy](https://docs.cozy.io/en/) application that allows users to conn
- Ecolyo Agent - Ecolyo Agent
- [Ecolyo-agent server](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-server) - [Ecolyo-agent server](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-server)
- [Ecolyo-agent client](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-client) - [Ecolyo-agent client](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/backoffice-client)
## Konnectors
Ecolyo heavily rely on konnectors to work, check our [konnector documentation](../konnectors/index.md).
# Deploy # Deploy Ecolyo
This section will show you how to deploy your project on different environments. This section will show you how to deploy your project on different environments.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment