2. Installation

Every project contains a README.md file. These files are important and MUST be maintained.

Environment variables

Each project uses environment variables to customize their behaviour across the different environment. This has been proved to be the best and most usec practice across organizations. You must setup your IDE or web server to implement and warm up those configurations before serving the application.

In each README.md file, you will find an Environment variables section that list all the key/values you need to setup. These values shouldn't be placed in your Windows or OS environment variables panel but either part of your initialization process while serving each individual project.

For instance, using PHPStorm or WebStorm, you can paste and adjust each configuration as part of a Run Configuration.

Front-end projects

To install a front-end project on your local machine, make sure you have Node and NPM installed to the proper version (see Standardization page).

1. Clone the repository on your local machine under C:\dev. Once cloned, it should have the path C:\dev\[REPO_NAME]
2. In a terminal, run npm install. If any error occurs, delete npm_modules folder and package.lock.json file and start over. If you are still experiencing issues, run npm --version (make sure you are using the correct version) and if so, investigate.
3. If step 2 succeeded, run npm serve or npm start. Watch for the logs to retrieve the URL and port to use.
4. Copy-paste that URL in your browser.

Back-end projects

To install a back-end project on your local machine, make sure you have PHP and MySQL installed to the proper version (see Standardization page).

1. Clone the repository on your local machine under C:\dev. Once cloned, it should have the path C:\dev\[REPO_NAME]
2. In a terminal, run composer install. If any error occurs, delete vendor folder and composer.lock file and start over. If you are still experiencing issues, run php --version (make sure you are using the correct version) and if so, investigate.
3. Check out the README.me file for the virtual host guidelines. Setup your Apache or nGinx server in consequence.
4. Restart your web server. Copy-paste your virtual host URL in your browser.