Environment Setup

Developer Environment Setup

This document outlines the various steps used to setup a development environment for working with the Caring Calendar code.

Prerequisites

Setup AWS Account Credentials

1. Create a folder in your home directory called .aws if it does not already exist. For example:

   Windows - C:\Users\<username>\.aws 
   Linux - /home/<username>/.aws
   Mac -  Users/<username>/.aws
   

2. Download the AWS credentials file from here
   • NOTES:
     • There is no file extension; if the editor adds one after the file is saved it must be renamed
     • These are temporary credentials to be replaced once you have an account created
3. Request a new user in the AWS account
4. Update the credentials file with the access key id and secret access key provided

Ubuntu Linux

1. Ensure python3.8 is installed

   sudo apt update
   sudo apt- install python3.8 python3.8-dev python3.8-distutils python3.8-venv
   

2. Install git

   sudo apt install git
   

3. Install Node Version Manager (nvm) using the installation steps listed on here
4. Close terminal and reopen
5. Install the latest Node LTS 12.x version using nvm
6. Install PyCharm

   sudo apt install snapd
   sudo snap install pycharm-community --classic
   

7. Clone the Caring Calendar API project
8. Change into the 'develop' branch if not already there
9. Follow the steps outlined in the README file to install the required packages and libraries

Windows

Due to the limitations in the way python3 is setup the project cannot be run natively in Windows. The recommended solution is to setup the code using a virtual machine image with all of the development tools pre-installed. The steps for this can be found below:

1. Install the latest version of VirtualBox
2. Download the base image from here
3. Open Virtual Box and click Import and select the location of the downloaded OVA file
   • Ensure you uncheck the USB option
4. Once imported start the VM
5. Login with the 'CT User'
   • You should be prompted to change the user's password
   • The old password is Ch8ngeMe!
6. Clone the Caring Calendar API project
7. Change into the 'develop' branch if not already there
8. Run the project locally using the AWS credentials profile name called 'civic-tech'

Mac OSX

Content coming...