The Volunteer Core project is a web app that assists in better management of Volunteer Core operations. It will track opportunities for volunteers, and volunteers. Later features could include communications to build out functionality similar to a CRM.
This setup is for use with local development only; production instructions will be included later. Do not use these instructions in production without turning off debug and resetting the SECRET_KEY in the .env variables.
You will need git to clone this repo.
For the backend you need python 3, venv, pip, and SQLite installed. Depending where you get Python from, venv may already be included with Python.
Clone the repo and cd into the created directory
python3 -m venv venvsource venv/bin/activepip install -r requirements.txtcp config.env.template .envflask db upgrade- Create the admin user:
flask auto-setup flask run- You can later end the app with ctrl + c.
curl https://$\{HOST\}/api/users/create \
-H 'Content-Type: application/json' \
-d '{"username":"username","password":"password","email":"email@example.com"}'We welcome new contributors. Be sure to check out the guide on contributing, which includes instructions on how to fork, clone, branch, commit, pull request and sync your fork.
Not sure where to start? Look for open issues on GitHub, or message the team on our Slack site. If you aren't on our Slack, click here for an invite.
TL;DR Contribution Workflow:
- Fork this repository and Clone your fork locally.
- Checkout a new branch on which to make your changes.
- Make edits. Try to match existing coding style.
- Test your changes.
- Commit your changes. Push your changes to your fork on GitHub.
- Submit a new pull request and your changes will be reviewed and merged.
We encourage you to open up an issue if you have any feedback, suggestions, bugs or just have a question on where to start.
MIT, see LICENSE for full license.