Treasurer Tools

A Django-based system to assist Non-Profit Organization treasurers in managing/tracking finances.

License:	GPLv3

Basic Commands

Initialize Development Environment

1. Install the development environment with Poetry:

   $ poetry install
   

2. Copy the /config/settings/.treasurer_tools.env file to /config/settings/treasurer_tools.env and update the details for your environment.

3. Run the database migrations:

   $ poetry run python manage.py migrate
   

3. Copy the test logo file (/treasurer_tools/branch_details/fixtures/test_logo.png) to the /treasurer_tools/media folder.

4. Load the fixture data:

   $ poetry run python manage.py loaddata country.json branch.json financial_codes.json
   

Running The Test Server

1. Run the following command:

   $ poetry run python manage.py runserver
   

Setting Up Your Users

• To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

• To create an superuser account, use this command:

  $ python manage.py createsuperuser
  

After account creation, go into the Admin site and fill in the other details for the user model (e.g., Name), as this is used in various parts of the app.

Test coverage

To run the tests:

$ poetry run pytest

Issues to Workout

• Developer/Superuser
• Branch Delegate(s)
• President - President only one with ability to upgrade user status?
• Treasurer