Skip to content
This repository has been archived by the owner on Mar 2, 2023. It is now read-only.

oeglobal/oeweek2022

Repository files navigation

Django app for Open Education Week

Installation / deployment

See README in ansible subdirectory (need to apt install several packages for the screenshot functionality to work -- without it, the installation will crash).

Special case: front-end only

In case you are going to do only local development focused on front-end (e.g. no need for scheduled tasks like screenshot fetching. etc.) then above mentioned ansible/README.md still applies but:

  • localsettings.py: add following
FE_DEPLOYMENT = True
  • pip install -r requirements.txt: do following instead after BASE_DIR = ...
pip install -r requirements-fe.txt

The rest should be the same.

Notes

Development

Branches, pull-requests, releases, etc.: according to git-flow but ...

... in order to allow better overview for current and future contributors, we'd like to conclude features with pull-requests, i.e. instead of git flow feature finish MYFEATURE do following:

  1. git flow feature publish MYFEATURE
  2. go to GitLab/GitHub and open pull-request from your feature branch to develop
  3. review + adjustments
  4. merge + delete branch after merge

Git hooks

For source code formatting, etc.:

pre-commit install