covenant-finance

A program for the purpose of yearly advancement and tracking of covenant finances and advancement.

Design Diagram:

To set up your own instance or do local development:

• Prereqs:
  • PSQL
    • edit "/etc/postgresql/14/main/pg_hba.conf" and swap "local all all md5" with "local all all trust"
    • sudo -i -u postgres
    • psql
    • CREATE DATABASE finance;
    • CREATE ROLE finance WITH LOGIN ENCRYPTED PASSWORD 'password';
    • GRANT ALL PRIVILEGES ON DATABASE finance TO finance;
  • Ensure your database is running off port 5432 (default)
    • If you set a password and/or a secret key, put the values in ./database_password.py
  • Reenable password authentication
    • edit "/etc/postgresql/14/main/pg_hba.conf" and swap "local all all trust" with "local all all md5"
  • Virtualenv:
    • python -m venv venv
    • echo "export ENV_FILE_LOCATION='./.env'" >> ./venv/bin/activate
    • source ./venv/bin/activate
• Self hosting:
  • Download project
  • sudo apt-get install apache2-dev
  • pip install -r requirements.txt
  • python -m venv venv
  • source venv/bin/activate
  • python app.py
• Initialize Database Tables:
  • In a python terminal within the virtual env:
    • from app import initialize_database
    • initialize_database()
• If using a browser:
  • Open browser to "http://localhost:8000/"
• If using CLI:
  • python
  • import src.covenant as C
  • c = C.Covenant()
  • Make any modifications
  • C.save_covenant

TODO BEFORE BETA:

• HOSTING FIXES:
  • Change '/flask_session' location and permissions
  • Change '/test.log' location and permissions
• User related:
  • User registration email validation
  • User change password
  • Password recovery
  • Add tooltip to explain 250 income for greater virtue, 100 income for typical
  • Add tooltips to describe different roles under covenfolk (Specialist vs Crafter for example)
  • Add tooltips in general
  • Replace error screens with proper errors
  • Export covenant
  • Cost breakdown by type in covenant page
• Dev related:
  • Front end tests
  • Cap number of covenants a user can have
  • Cap number of income sources a covenant can have TODO MAYBES BEFORE BETA:
  • Add column in covenfolk to show max savings possible per crafter/specialist

TODO BEFORE RELEASE:

• Graphics
• Basic security audit (Cross site forgery, DDOS, etc)
• Throttle on failed logins
• Database backup (1 week? 3 weeks?)

BUGS TO FIX:

• Login with non existant user throws error
• Fail covenant validation throws error page
• Fail lab validation (unique name) throws error page
• Covenant names are currently globally unique, need to be unique per user
• User's covenants do not populate until new login (create covenant redirect missing data)
• New Covenent screen's Income Sources +/- button is offset on the first entry for some reason (create multiple and look at the first)
• Specialsts do not provide savings

RANDOM STUFF:

• Manual steps to get PSQL running on GKE:
  • Followed instructions here: https://cloud.google.com/kubernetes-engine/docs/tutorials/stateful-workloads/postgresql
  • The versions of the pg* images are all wrong, need to be updated. Can be found by inspecting the pod failures
  • Creating pg-client pod, entering PSQL admin through psql -h $HOST_PGPOOL -U postgres, used that to create finance DB and finance_owner account
  • Ran the following command from within the pgpool pod to add finance_owner's login:
    • pg_enc -m -f "/opt/bitnami/pgpool/conf/pgpool.conf" -k "/opt/bitnami/pgpool/conf/.pgpoolkey" -u user password