README.md

PySprings Badging System

A web application to keep track of 'merit badges' for the PySprings users group.

This is a Django application that allows for people to track what they've learned. It also allows you to see what you have the prerequisites for.

Getting Started

Environment Setup

1. Clone the project
2. cd into the source folder
3. Ensure Python3.6 is installed
   python3.6 --version
4. Ensure pipenv is installed
   pipenv --version
5. Create a virtual environment with pipenv
pipenv install --dev
6. Activate the virtual environment
   pipenv shell
7. Install the pre-commit hooks
   pre-commit install

Running the project

• Clone project & cd to the badging folder
• run python manage.py migrate
• python manage.py runserver to start on localhost

Build

TODO: Continuous integration

Testing

To run the tests, run the command make tests or pytest in the root directory.

Installation

TODO

Contribution Guide

• Pull requests welcome.
• Summarize your change in the present imperative on the first of your commits.
• Please reference any tickets that should be closed in the body so GitHub will do so automatically.

License

See LICENSE