Setup

Setup to Run This Code

In order to run this web app you will need to install some things on your local:

Node.js and npm

Install node.js and npm on your local. You can download from https://nodejs.org/

You may also want to install 'nodemon' which is useful: sudo npm i -g nodemon

Xcode

If you already have XCode installed then great. If not then you can install it but beware because it is really huge. You only need the gcc part so if you want to save space on your local is it fine to just install the part you need for this project: xcode -select --install

PostgreSQL

If you plan to run the web app locally on your PC then you will need to set up a PostgreSQL database. The first step is to install PostgreSQL: https://www.postgresql.org/download/

Once the software is installed you can confirm by trying to run the 'psql' command:

psql --version

Additional setup if you want to contribute

Git

If you'd like to contribute to this repository you will need to install git on your local. You can follow the instructions here: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git. You will only need the cli (Command Line Interface) but if you prefer to use the git app gui that is up to you.

IDE or Editor

You may want to install an editor (such as Visual Code Studioor Sublime) to help with your development but it is not required (you can edit the src code any way you like).

Heroku Setup

If you will want to deploy your changes to your own personal Heroku you can create an account here: https://signup.heroku.com/login

And you will need to install the Heroku CLI on your local. Follow instructions here:

https://devcenter.heroku.com/articles/heroku-cli

You will also need to provision a PostgreSQL database on your heroku. See the Postgres wiki for instructions.