Skip to content
Snippets Groups Projects
Commit b9fff6e7 authored by CARRON Guilhem's avatar CARRON Guilhem
Browse files

add scaffolding page + gitflow

parent 89fd6251
No related branches found
No related tags found
No related merge requests found
!!! info ""
:construction: Section under Construction :construction:
Ecolyo is a [Cozy](https://docs.cozy.io/en/) application that allows users to connect their energy accounts such as **EGL**, **ENEDIS** and **GRDF**, using cozy [konnectors](https://docs.cozy.io/en/cozy-stack/konnectors/)
!!! info ""
:construction: Section under Construction :construction:
\ No newline at end of file
:construction: Section under Construction :construction:
## Initialize
- Create a new projet in gitlab and take note of its url
### Protecting Master Branch
On the gitlab page of your project go to *Settings/Repository* in the *Protected Branches* section.
Select the **Master** branch and set **allow to merge** to ***Master*** and **allow to push** to **No one**
This will prevent anyone to push on the master branch, the only way to add code to the branch will be using merge requests.
### Setting Development Branch
- Retrieve the project on your computer, open a command line and execute.
```
git clone https://forge.grandlyon.com/web-et-numerique/llle.git
```
- Create the development branch
```
git checkout -b dev
```
- Init your project and then type any time you want to commit changes:
```
git add .
git commit -m "Commit changes"
git push origin dev
```
## Start Developing
For any other development you should create a branch from the development branch.
First make sure to be on the ***dev*** branch, type:
```
git branch
```
> to see your current branch
### Conventional Commits
The commit contains the following structural **types**:
- fix
- feature
In our team organisation we are using IceScrum to keep track of our User Stories (US). Each US is identified by a number. In order to easily identify the commit that refers to the US, a `feature` branch name should follow this structure:
- *features/<number of the User Story\>-<title_of_the_user_story\>*
You can create the branch by typing:
```
git checkout -b features/<number of the User Story>-<title_of_the_user_story>
```
> Note that the **feature** type is the only one with a dedicated folder (features/-US).
Each fix branch should be named as the following *fix-\<title_of_the_fix\>*.
You can create the branch by typing:
```
git checkout -b fix-<title_of_the_fix>
```
**Breaking Change**
Appends a `!` before the title of the commit to notify that a breaking change has happened. Give a solid description of the changes as well.
**Types** other than fix and feature are allowed, for example *build*, *chore*, *ci*, *docs*, *style*, *refactor*, *perf*, *test* and others.
**add tag**
```
git tag -a 1.0.0 -m "complementary message"
```
### Gitflow Scheme
![Gitflow](/img/gitflow.png)
\ No newline at end of file
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/ContainerComponents | In this folder you'll find parent components which calls chlidren **Content Components**
components/ContentComponents | In this folder you'll find every content component that are called by **Container Components**
components/Contexts | This folder contains the component used to set the context of the application
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)
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
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
docs/img/gitflow.png

62.8 KiB

site_name: LLLE-Ecolyo Technical Docs
site_description: LLLE Project Documentation with Markdown.
site_author: LLLE Team
repo_name: 'Clone the Project'
repo_url: 'https://forge.grandlyon.com/web-et-numerique/llle_project/llle_docs'
repo_name: "Clone the Project"
repo_url: "https://forge.grandlyon.com/web-et-numerique/llle_project/llle_docs"
theme:
name: 'material'
# logo: 'assets/favicon.ico'
# favicon: 'assets/favicon.ico'
palette:
primary: 'black'
accent: 'Deep Orange'
name: "material"
# logo: 'assets/favicon.ico'
# favicon: 'assets/favicon.ico'
palette:
primary: "black"
accent: "Deep Orange"
markdown_extensions:
- admonition
- attr_list
- plantuml_markdown:
server: http://www.plantuml.com/plantuml
- pymdownx.emoji
- admonition
- attr_list
- plantuml_markdown:
server: http://www.plantuml.com/plantuml
- pymdownx.emoji
nav:
- Home: index.md
- Getting started:
- Setup your environment: getting_started/setup_your_environment.md
- Launch the application on local : getting_started/launch_local_application.md
- Launch a konnector on local : getting_started/launch_local_konnector.md
- Project Architecture:
- Architecture : project_architecture/architecture.md
- Cozy : project_architecture/cozy.md
- Environments : project_architecture/environments.md
- DocTypes : project_architecture/doctypes.md
- Application:
- Description: application/description.md
- Gitflow: application/gitflow.md
- Konnectors:
- Enedis: konnectors/enedis.md
- GRDF: konnectors/grdf.md
- Eau du Grand Lyon: konnectors/egl.md
- Proxy:
- Description: proxy/description.md
- Home: index.md
- Getting started:
- Setup your environment: getting_started/setup_your_environment.md
- Launch the application on local: getting_started/launch_local_application.md
- Launch a konnector on local: getting_started/launch_local_konnector.md
- Project Architecture:
- Architecture: project_architecture/architecture.md
- Cozy: project_architecture/cozy.md
- Environments: project_architecture/environments.md
- DocTypes: project_architecture/doctypes.md
- Application:
- Description: application/description.md
- Scaffolding: application/scaffolding.md
- Gitflow: application/gitflow.md
- Konnectors:
- Enedis: konnectors/enedis.md
- GRDF: konnectors/grdf.md
- Eau du Grand Lyon: konnectors/egl.md
- Proxy:
- Description: proxy/description.md
This diff is collapsed.
This diff is collapsed.
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