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

update setup

parent 84f72151
No related branches found
No related tags found
No related merge requests found
Pipeline #89803 passed
......@@ -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.
![europe](/img/partners/europe.png){: .inline-center-left}
![auvergne](/img/partners/auvergne.png)
......@@ -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:
- [Clipboard Manager](https://marketplace.visualstudio.com/items?itemName=EdgardMessias.clipboard-manager)
- [ES7+ React/Redux/React-Native snippets](https://marketplace.visualstudio.com/items?itemName=dsznajder.es7-react-js-snippets)
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- [GitLens - Git supercharged](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
- [Jest Runner](https://marketplace.visualstudio.com/items?itemName=firsttris.vscode-jest-runner)
- [Jest](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest)
- [Markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
- [SonarLint](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarlint-vscode)
......@@ -28,8 +25,6 @@ Optional extensions:
- CSS Peek
- Auto Rename Tag
- indent-rainbow
- Liveshare (pair programming extension)
### User settings
......@@ -49,16 +44,12 @@ Open the project with VSCode and add the following code into `.vscode/settings.j
"gitlens.advanced.messages": {
"suppressShowKeyBindingsNotice": true
},
"workbench.colorCustomizations": {
/* Put anything you like here */
},
"workbench.settings.editor": "json",
}
```
## Install your Linux distribution
If you're using windows, we highly recommand to install WSL. Checkout the official documation for installation or our [installation wiki](wsl.md).
If you're using windows, we highly recommend to [install WSL](wsl.md). Also checkout the official documentation.
### Setup your distribution
......@@ -76,22 +67,13 @@ If you're using windows, we highly recommand to install WSL. Checkout the offici
## Installing prerequisites
Name | Required | Details
---------------------------------- | -------- | -------
[Docker-compose](https://docs.docker.com/compose/install/) | Yes
[Docker](https://www.docker.com/get-started) | Yes | See [cozystack](https://docs.cozy.io/en/cozy-stack/) for more information.
Git | Yes |
[Node](https://nodejs.org/en/download/) | Yes | Node 14 and 16 must be installed as it is the version that runs on the official cozystack.
[WSL](index.md#wsl) | No | Required for windows users.
[Yarn](https://classic.yarnpkg.com/en/docs/install) | Yes | Yarn is our projects package manager.
### Git
We are using Gitlab, you will need to [install Git](https://git-scm.com/) to checkout projects. Make sure to configure your informations :
We are using Gitlab. Make sure to configure your informations :
```sh
git config --global user.name "First_name LAST_NAME"
git config --global user.email "email@example.com"
git config --global user.email "email@grandlyon.com"
```
!!! info "Git version"
......@@ -111,9 +93,19 @@ git config --global user.email "email@example.com"
### Node
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).
......
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