Awesome Open Source
Awesome Open Source

Backend for education.borshev.com

CircleCI Maintainability Test Coverage

Django-based production project, integrated with Tinkoff, zoom.us, Mailchimp, Postmark, S3 and telegram. Frontend is built on vue.js in the separate repo.

Configuration

Configuration is stored in src/app/.env, for examples see src/app/.env.ci

Installing on a local machine

This project requires python3.8 and sqlite.

Install requirements:

cd src && pip install -r requirements.txt
cp app/.env.ci app/.env  # default environment variables
./manage.py migrate
./manage.py createsuperuser

Testing:

# run unit tests
$ pytest

Development servers:

# run django dev server
$ ./manage.py runserver

Backend Code requirements

Style

  • Obey django's style guide.
  • Configure your IDE to use flake8 for checking your python code. For running flake8 manualy, do cd src && flake8
  • Prefer English over your native language in comments and commit messages.
  • Commit messages should contain the unique id of issue they are linked to (refs #100500)
  • Every model and a model method should have a docstring.

Code organisation


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
python (54,621
django (1,033
django-rest-framework (138
pytest (77
django-application (41
lms (30