@@ -10,7 +10,7 @@ In order to work with a self-data environment, there are a couple of prerequisit
### Grandlyon resources
Don't forget to take a look at our [Factory wiki]((https://forge.grandlyon.com/web-et-numerique/factory/wiki_web_num) describing general organizational processes.
Don't forget to take a look at our [Factory wiki](https://forge.grandlyon.com/web-et-numerique/factory/wiki_web_num) describing general organizational processes.
### Cozy resources
...
...
@@ -21,18 +21,16 @@ Link | Details
## Contributing to the documentation
### Clone the project
See the [contributing guide](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/self-data-technical-doc/-/blob/master/CONTRIBUTING.md) or follow the next section
To install and run the documentation on your laptop, follow the steps in the [README](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/self-data-technical-doc). Then:
### Click the edit button
- Create a branch for your change
- Add documentation pages to `docs`, and supporting assets to `img`.
- Write some [markdown](https://guides.github.com/features/mastering-markdown/)
- Submit a merge request
The edit buttons allow quick edits for single pages. To do so :
### Click the edit button
- click the **edit button** at the top right
- commit to a new branch and open a merge request
Click the edit button at the very top, commit to a new branch and open a merge request.
A developer will check your changes and approve them.
@@ -4,20 +4,17 @@ This section will allow you to install a proper local environment step by step.
## VSCode
### Install VSCode
Installation for VSCode can be found [here](https://code.visualstudio.com/).
VSCode is the recommended IDE.
### Extensions
Some of our projects might contain a `/.vscode/extensions.json`to recommand specific extesions. But here is a list of general important extensions to install:
Some of our projects might recommend specific list extensions with a `.vscode/extensions.json`file. Here here is a generic list of important extensions to install:
Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine. [Install here](https://nodejs.org/en/download/)
Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
!!! warning "We need different versions for our projects so we will have to install a node version manager (more on that later)."
#### NVM
For our projects you will need to have a version manager for node such as [**n**](https://www.npmjs.com/package/n), [**fnm**](https://github.com/Schniz/fnm), [**nvm**](https://github.com/nvm-sh/nvm) and [**nvm-windows**](https://github.com/coreybutler/nvm-windows). Install both at least version **16**.
You can then check the current version of node used
!!! warning "We need versions 14 & 16 for our projects so we will have to install a node version manager (more on that later)."
```sh
node -v
```
### Npm
...
...
@@ -139,38 +131,12 @@ npm i -g yarn
yarn -v
```
#### NVM
For our projects you will need to have a version manager for node such as [**n**](https://www.npmjs.com/package/n), [**nvm**](https://github.com/nvm-sh/nvm) and [**nvm-windows**](https://github.com/coreybutler/nvm-windows) on windows. Install both **14** and **16** versions.
```sh
yarn global add nvm
```
=== "Install a version"
```sh
nvm install X.X.X
```
=== "See installed node versions"
```sh
nvm list
```
=== "Switch to a specific version"
```sh
nvm use X.X.X
```
You can then check the current version of node used
```sh
node -v
```
### Docker
Docker is a tool designed to make it easier to create, deploy, and run applications by using containers. Containers allow a developer to package up an application with all of the parts it needs, such as libraries and other dependencies, and ship it all out as one package. By doing so, thanks to the container, the developer can rest assured that the application will run on any other Linux machine regardless of any customized settings that machine might have that could differ from the machine used for writing and testing the code.
See [cozystack](https://docs.cozy.io/en/cozy-stack/) for more information.
#### Install Docker
Installation of Docker can be found here: [Installation of Docker](https://www.docker.com/get-started).