setup_your_environment.md

Setup your environment

This section will allow you to install a proper local environment step by step.

VSCode

Install VSCode

Installation for VSCode can be found here.

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:

• Clipboard Manager
• ES7+ React/Redux/React-Native snippets
• ESLint
• GitLens - Git supercharged
• Jest Runner
• Jest
• Markdownlint
• Prettier - Code formatter
• SonarLint
• TabOut
• Todo Tree

Optional extensions:

• CSS Peek
• Auto Rename Tag
• indent-rainbow
• Liveshare (pair programming extension)

User settings

Open the project with VSCode and add the following code into .vscode/settings.json:

{
  "breadcrumbs.enabled": true,
  "editor.snippetSuggestions": "top",
  "editor.tabSize": 2,
  "editor.formatOnSave": true,
  "editor.formatOnPaste": true,
  "editor.formatOnSave": true,
  "diffEditor.ignoreTrimWhitespace": false,
  "javascript.updateImportsOnFileMove.enabled": "always",
  "window.zoomLevel": 0,
  "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.

Setup your distribution

1. Start updating the packages list by typing:

   sudo apt update

2. Install nodejs using the apt package manager

   sudo apt install

Installing prerequisites

Name	Required	Details
Docker-compose	Yes
Docker	Yes	See cozystack for more information.
Git	Yes
Node	Yes	Node 14 and 16 must be installed as it is the version that runs on the official cozystack.
WSL	No	Required for windows users.
Yarn	Yes	Yarn is our projects package manager.

Git