Skip to content
Snippets Groups Projects
Commit 82b9cc7c authored by Bastien DUMONT's avatar Bastien DUMONT :angel:
Browse files

installation doc & scaffolding

parent dec99fb5
No related branches found
No related tags found
1 merge request!7fix: installation doc & scaffolding
......@@ -14,11 +14,14 @@ In this section, you will find information about the project file structure and
| doctypes | This folder contains the **cozy** doctypes, you can see more on [Cozy Documentation](https://github.com/cozy/cozy-doctypes) |
| 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) |
| migrations | This folder contains all migrations
| models | This folder contains all models |
| notifications | This folder contains all mail notifications |
| 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 |
| types |
| utils | In this folder you'll find utilitaries methods |
##Configuration Files
......
......@@ -87,7 +87,7 @@ Once successfull you can launch your local cozy with following url [Cozy local u
Local database can also be consulted at the following url: [Cozy local DB](http://localhost:5984/_utils/)
## Import moke data
## Import mock data
!!! info "Requirement"
Your dev stack should be running to import the moke data
......@@ -130,6 +130,8 @@ cd scripts
```
!!! info ""
If you cannot execute ```ACH``` after this command, it may be because you do not have the directory where yarn stores its symbolic links in your ```PATH```. Edit it to append the result of ```yarn global bin```.
You'll be prompted for a cozysessid, you can get it in the web console ; in the `application` tab, look for the cookies and just copy the cozysessid value.
A new browser windows will open and asking you approval to import data. Just click on **Approve**
......
......@@ -36,8 +36,6 @@ Open the project with VSCode and add the following code into .vscode/settings.js
/* Put anything you like here */
},
"editor.snippetSuggestions": "top",
"editor.tabSize": 2,
"editor.formatOnSave": true,
"diffEditor.ignoreTrimWhitespace": false,
"window.zoomLevel": 0,
"gitlens.advanced.messages": {
......@@ -78,7 +76,7 @@ Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
## Yarn
Yarn is used as package manager for this project. Feel free to use the one you prefere but we advice to install yarn as all the documentation is described with this package manager.
Installation for yarn can be found here: [Installation of Yarn](https://classic.yarnpkg.com/fr/docs/install/).
Installation for yarn can be found here: [Installation of Yarn](https://classic.yarnpkg.com/en/docs/install).
## Docker
......
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