-
Guilhem CARRON authoredGuilhem CARRON authored
scaffolding.md 6.52 KiB
In this section, you will find information about the project file structure and the purpose of the main folders.
##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 |
| 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 |
| 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 |
| 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 |
##Configuration Files
| Folder/File | Purpose |
|---|---|
| .eslintrc.js | Config file for ESLint |
| gitlab-ci.yml | Config file used for Gitlab continuous integration |
| .prettierrc | Config file for Prettier extension |
| config.json | Config file for fluid types |
| jest.config.js | Config file used by Jest for testing the application |
| manifest.webapp | Manifest of the application, used by cozy for the managment of permissions, you can add permissions for doctypes there |
| tsconfig.json | Config file for TypeScript |