From 1786248266b47dd5c458c6f6b87e76a581e1bfa4 Mon Sep 17 00:00:00 2001 From: Yoan VALLET <ext.sopra.yvallet@grandlyon.com> Date: Tue, 16 Feb 2021 10:15:38 +0100 Subject: [PATCH] update scaffolding section --- docs/ecolyo/application/scaffolding.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/ecolyo/application/scaffolding.md b/docs/ecolyo/application/scaffolding.md index ba021ee..0110961 100644 --- a/docs/ecolyo/application/scaffolding.md +++ b/docs/ecolyo/application/scaffolding.md @@ -5,16 +5,17 @@ In this section, you will find information about the project file structure and | Folder/File | Purpose | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | assets | The application's assets, contains fonts, svg and png files | +| components | The application's components. | | 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 | +| components/App.tsx | The root component, it calls the Routes 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. | +| enum | This folder contains all enums like 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 | +| services | This folder contains 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 | -- GitLab