A bug management system
JavaScript Python CSS Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
edwin
.buildpacks
.editorconfig
.eslintrc
.gitignore
.pre-commit-config.yaml
.travis.yml
LICENSE
Procfile
README.md
REFERENCE.md
app.json
manage.py
package.json
requirements.txt

README.md

Summary

Edwin is a bug management system.

Requirements

  1. Python 3.4
  2. npm
  3. a monkey with a banana

Install for hacking

  1. create a virtual environment
  2. run pip install -r requirements.txt
  3. run ./manage.py migrate
  4. run npm install

Note

You'll be using the Dev configuration by default. Make sure to change this for deployments by setting the DJANGO_CONFIGURATION environment variable.

pre-commit

You can run pre-commit install to set up the pre-commit machinery which will lint changes before you commit. Linting saves lives.

Run tests

Python tests

  1. run ./manage.py test to run tests for the backend.

JS tests

  1. run npm test to run Jest tests for frontend code.

Deployments

Edwin is designed to be deployed on Heroku using the multi-buildpack.

Environment Variables

For deployments, a few environment variables should be set.

  • DJANGO_CONFIGURATION - This should be set to Base for most production deployments.
  • DJANGO_SECRET_KEY - This should be a long random string.
  • DJANGO_ALLOWED_HOSTS - This should be the hostname (and only the hostname) the deployment can be reached at. It may be multiple values separated by commas. Example: edwin-dev.herokuapp.com,edwin.example.com.
  • DJANGO_DATABASES - This should be set to a DB URL for your database. Example: sqlite:// for an in-memory sqlite storage. Heroku sets this automatically.

Usage

Creating a super user account

You need a super user account to log into the admin. Run:

./manage.py createsuperuser

and answer the questions.

Creating and editing teams

  1. Go to the admin https://HOST/admin.
  2. Log in as the superuser.
  3. Click on Teams.

You can create, edit and delete teams here.