TODO: Instructions for use
- mysql-client
MacOS:
brew install mysql-client
- python requirements
py3 -m pip install -r requirements.txt
- docker (optional)
docker compose up -d
- fork this repository
- clone it down to your local dev machine
- run
python3 -m pip install -r requirements.txt
to get your packages - run
cp src/configuration.py.sample src/configuration.py
and edit the new file to ensure your database URL is correct if you are not using docker. - develop features in a features/ branch
- include tests where possible
- when you are finished, be sure to rebase your master then rebase the feature to master
- push back to your repository
- create a pull request for review