Skip to content
A web application to keep track of 'merit badges' for the PySprings users group.
Branch: master
Clone or download
Pull request Compare This branch is 60 commits ahead, 2 commits behind mtthedragon01:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/issue_templates
badging
tests
users
.gitignore
.pre-commit-config.yaml
.pylintrc
.travis.yml
LICENSE
Makefile
Pipfile
Pipfile.lock
README.md
manage.py
pyproject.toml
setup.cfg

README.md

PySprings Badging System

Build Status

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

You can’t perform that action at this time.