Skip to content
Snippets Groups Projects
Commit 9a650168 authored by HAUTBOIS Aurelie's avatar HAUTBOIS Aurelie
Browse files

update scaffolding

parent f5da4853
No related branches found
No related tags found
No related merge requests found
Pipeline #10461 passed
...@@ -2,34 +2,31 @@ In this section, you will find information about the project file structure and ...@@ -2,34 +2,31 @@ In this section, you will find information about the project file structure and
##Source Files ##Source Files
Folder/File | Purpose | Folder/File | Purpose |
------------ | ------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
assets | The application's assets, contains fonts, svg and png files | 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/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/ContainerComponents | In this folder you'll find parent components which calls chlidren **Content Components** | components/Hooks | This folder contains the hooks of the application |
components/ContentComponents | In this folder you'll find every content component that are called by **Container Components** | App.jsx | The root component, it calls the Container component '**ViewContainer**' which is our main component |
components/Contexts | This folder contains the component used to set the context of the application | db | In this folder, you'll find JSON data used for challenges, ecogestures, and the FAQ. |
components/Hooks | This folder contains the hooks of the application | doctypes | This folder contains the **cozy** doctypes, you can see more on [Cozy Documentation](https://github.com/cozy/cozy-doctypes) |
App.jsx | The root component, it calls the Container component '**ViewContainer**' which is our main component | enum | This folder contains enums for Fluid types, Screen types, and Timesteps. |
db | In this folder, you'll find JSON data used for challenges, ecogestures, and the FAQ. | locales | This folder contains JSON data used by the translation system i18n provided by [Cozy-ui](https://github.com/cozy/cozy-ui) |
doctypes| This folder contains the **cozy** doctypes, you can see more on [Cozy Documentation](https://github.com/cozy/cozy-doctypes) | models | This folder contains all models |
enum| This folder contains enums for Fluid types, Screen types, and Timesteps. | services | Here you'll find all the services |
locales| This folder contains JSON data used by the translation system i18n provided by [Cozy-ui](https://github.com/cozy/cozy-ui) | store | This folder contains all actions and reducers classified by component |
services| Here you'll find all the services | styles | The styles folder you'll find a **base** folder that contains our variables and a **components** folder that contains components styles |
styles | The styles folder you'll find a **base** folder that contains our variables and a **components** folder that contains components styles | targets |
targets | | utils | In this folder you'll find utilitaries methods |
utils | In this folder you'll find utilitaries methods
##Configuration Files ##Configuration Files
Folder/File | Purpose | Folder/File | Purpose |
------------ | ------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------- |
.eslintrc.js | Config file for ESLint | .eslintrc.js | Config file for ESLint |
gitlab-ci.yml | Config file used for Gitlab continuous integration | gitlab-ci.yml | Config file used for Gitlab continuous integration |
.prettierrc | Config file for Prettier extension | .prettierrc | Config file for Prettier extension |
config.json | Config file for fluid types | config.json | Config file for fluid types |
jest.config.js | Config file used by Jest for testing the application | 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 | 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 | tsconfig.json | Config file for TypeScript |
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