VAC Benefits Directory

This is the code for the VAC Benefits Directory being developed by VAC and CDS. The app is currently deployed at https://cdsvacpoc.azurewebsites.net/

The setup documentation can be found below. If you'd like to contribute to the project, we have more detailed documentation regarding our tech choices here: DOCUMENTATION.md.

Quickstart

• yarn install
• yarn dev

How to get VAC Benefits Directory to work on VAC machines (May 31, 2018)

• download Node.JS of version 9 or newer(as .zip since .msi is blocked)

• following steps required tp set up the newly installed Node cmd line commands such as npm globally

  Start menu > Control Panel > User accounts > user accounts > change my environment variables > select path > Edit > Now enter the location of where you have Node installed with a ; to seperate between any other entries here. EX: C:\dev ; C:\Node

• npm install -g yarn

• yarn install (While in project main directory, takes a while, especially on building packages)

• yarn dev (run while CD'd in project folder used to start the local server)

• If you run into syntax errors chances are there are missing packages/dependencies and you may want to try running a clean yarn install. Delete Node_modules folder and then re run yarn install in the main folder.

Configuration

The application uses Sentry.io for error logging. If you would also like to use sentry, make sure your public client key is the SENTRY_DSN environment variable.

Google Analytics is used for behaviour tracking, ex: How many people switch between languages. If you would like to include your own GA key set the GA_UA environment variable.

The Google maps api is used to display a map of area office locations. If you would like to include your own api key set the GOOGLE_MAPS_KEY environment variable.

Here is an example of how to add an ENV variable locally on OSX:

1. In the terminal, run: nano ~/.bash_profile (or nano ~/.zshrc if you're using the zsh shell)
2. Add the following line: export GOOGLE_MAPS_KEY="foo"
3. [ctrl] + x, and type y to save
4. source ~/.bash_profile (or source ~/.zshrc)
5. echo $GOOGLE_MAPS_KEY to make sure it is set
6. yarn dev to start the dev server
7. Visit http://localhost:3000/map with your browser to check that the map is loading

Adding a new environment variable to the source code

To add a new ENV variable to the source code, take the following steps:

1. Follow the steps above to add it locally

2. Reference it in the src code with process.env.YOUR_VARIABLE_NAME

3. Add the following lines to Dockerfile:

   ARG YOUR_VARIABLE_NAME
   ENV YOUR_VARIABLE_NAME ${YOUR_VARIABLE_NAME}
   

4. Add another build argument to config.yml: --build-arg YOUR_VARIABLE_NAME="${YOUR_VARIABLE_NAME}"

5. Add the ENV variable to CircleCI through their web interface: https://circleci.com/gh/cds-snc/vac-benefits-directory -> Settings -> Environment Variables

6. Add the ENV variable to Heroku through their web interface. It will need to be added to any production apps as well as the app that the pull request reviews are based on, namely vac-poc-staging. Go to the apps, then the Settings tab, then "Reveal Config Vars" and set the variable.

7. Add "YOUR_VARIABLE_NAME": { "required": true } to the env object in app.json

Reference

This application uses the following resources:

• NextJS https://learnnextjs.com/
• Jest https://facebook.github.io/jest/
• React i18next https://react.i18next.com/
• Prettier https://prettier.io/