Skip to content

samirhinojosa/Django-open-badges

Repository files navigation

Django Open Badges

Codacy Badge Build Status Coverage Status License: MIT

Simple Backend and Back-office application to manage the creation and granting of badges, certificates and credentials through Django framework

Development and Contributing

If you would like to contribute with the project, below you'll see how to start it with docker.

  1. Install Docker and Docker Compose
  2. In the root of the project's directory run in shell, the command
docker-compose up
  1. In another shell, prepare the migrations based on the apps
python manage.py makemigrations core
python manage.py makemigrations diplomas
  1. Make the migrations in the order below.
python manage.py migrate core
python manage.py migrate auth
python manage.py migrate contenttypes
python manage.py migrate admin
python manage.py migrate sessions
python manage.py migrate diplomas
  1. Create an admin user
python manage.py createsuperuser

With Visual Studio Code - Insiders

  1. Install Docker and Docker Compose
  2. Open the project with VSC - Insiders
  3. In a bash in VSC's terminal, prepare the migrations based on the apps
python manage.py makemigrations core
python manage.py makemigrations diplomas
  1. Make the migrations in the order below.
python manage.py migrate core
python manage.py migrate auth
python manage.py migrate contenttypes
python manage.py migrate admin
python manage.py migrate sessions
python manage.py migrate diplomas
  1. Create an admin user
python manage.py createsuperuser

Unit Test - Coverage

To run coverage, execute the command below

coverage run --source='.' manage.py test apps

Django Open Badges is an open source project, so contributing is as easy as forking the project on either of these sites and committing your enhancements. Please, don't forget include always tests. If you are fixing a bug, add a test that breaks before your patch and works after.

About

Simple Backend and Back-office application to manage the creation and granting of badges, certificates and credentials through Django framework

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published