README.md

FireApp2.0

Bushfire Volunteer Management Application (TL 20-S1-2-C Fire App), a web app to assist with firefighting scheduling activities.

Redmine
Project landing page

Backend Setup

The following steps describe the operations required to get the backend environment setup and working on a system. The specific steps for your system will vary and are therefore not detailed beyond linking to the individual install instructions. If you require help getting started, please post in the discord #general.

Please note that the versions used here are quite specific, please follow them.

Its recommended you use PyCharm Ultimate, you get it for free with you anu.edu.au email address.

1. Install Python 3.8+: Steps
2. Run the following commands in a terminal:
   a. cd backend
   b. pip install pipenv
   c. pipenv install
3. Install Minizinc: Steps
4. Install the AWS CLI: Steps
5. Configure the AWS CLI: Steps
   Note: Use the AWS_ACCESS_KEY and AWS_SECRET_ACCESS_KEY provided to you when you joined the team.
6. Restart your IDE so as to update your path.
7. Create a run configuration by adding a Flask runtime using the settings:
   Target Type: Script Path
   Target: /backend/application.py
   FLASK_ENV: development
   FLASK_DEBUG: true
   Working Directory: /backend
   Add Contents Root to Python Path: true
   Add Source Root to Python Path: true

Frontend Steps

1. Install NodeJS: Steps
2. Run the following commands in a terminal:
   a. cd ui
   b. npm install
3. Create a run configuration by adding a npm runtime using the settings:
   Package JSON: <where you've cloned the repo>\FireApp2.0\ui\package.json
   Command: run
   Script: debug\

Generate a Database Migration

1. cd backend
2. pipenv activate
3. alembic revision --autogenerate -m "<meaningful message>"

To run the migration:

1. alembic upgrade head