From 31a201d7de2b26961f80194028e976bd5179325c Mon Sep 17 00:00:00 2001 From: gcarron <gcarron@grandlyon.com> Date: Tue, 2 Feb 2021 14:39:35 +0100 Subject: [PATCH] Add constants folder --- docs/ecolyo/application/scaffolding.md | 31 +++++++++++++------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/ecolyo/application/scaffolding.md b/docs/ecolyo/application/scaffolding.md index 970304d..9f2095e 100644 --- a/docs/ecolyo/application/scaffolding.md +++ b/docs/ecolyo/application/scaffolding.md @@ -2,22 +2,23 @@ In this section, you will find information about the project file structure and ##Source Files -| Folder/File | Purpose | -| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| assets | The application's assets, contains fonts, svg and png files | -| components/CommonKit | In this folder you'll find global components such as Buttons, Cards, Icons, etc... Many of these components are overrided material-ui components | -| components/Hooks | This folder contains the hooks of the application | -| App.jsx | The root component, it calls the Container component '**ViewContainer**' which is our main component | -| db | In this folder, you'll find JSON data used for challenges, ecogestures, and the FAQ. | -| doctypes | This folder contains the **cozy** doctypes, you can see more on [Cozy Documentation](https://github.com/cozy/cozy-doctypes) | -| enum | This folder contains enums for Fluid types, Screen types, and Timesteps. | -| locales | This folder contains JSON data used by the translation system i18n provided by [Cozy-ui](https://github.com/cozy/cozy-ui) | -| models | This folder contains all models | -| services | Here you'll find all the services | -| store | This folder contains all actions and reducers classified by component | -| styles | The styles folder you'll find a **base** folder that contains our variables and a **components** folder that contains components styles | +| Folder/File | Purpose | +| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| assets | The application's assets, contains fonts, svg and png files | +| components/CommonKit | In this folder you'll find global components such as Buttons, Cards, Icons, etc... Many of these components are overrided material-ui components | +| components/Hooks | This folder contains the hooks of the application | +| App.jsx | The root component, it calls the Container component '**ViewContainer**' which is our main component | +| constants | This folder contains constants files such as **config.json** for the konnectors fluid config, **connexionWaitingText.json** for the sentences displayed while fetching fluid data, and a folder **consumptionConstants** that contains json files with constants for consumption calculation and comparison | +| db | In this folder, you'll find JSON data used for challenges, ecogestures, and the FAQ. | +| doctypes | This folder contains the **cozy** doctypes, you can see more on [Cozy Documentation](https://github.com/cozy/cozy-doctypes) | +| enum | This folder contains enums for Fluid types, Screen types, and Timesteps. | +| locales | This folder contains JSON data used by the translation system i18n provided by [Cozy-ui](https://github.com/cozy/cozy-ui) | +| models | This folder contains all models | +| services | Here you'll find all the services | +| store | This folder contains all actions and reducers classified by component | +| styles | The styles folder you'll find a **base** folder that contains our variables and a **components** folder that contains components styles | | targets | -| utils | In this folder you'll find utilitaries methods | +| utils | In this folder you'll find utilitaries methods | ##Configuration Files -- GitLab