LEGO Er Ganske Oppdelt
LEGO is the backend for abakus.no - the frontend is located at webkom/lego-webapp. Documentation is located at lego.abakus.no. We also have a beginner's guide for setting up LEGO.
We use GitHub issues and project boards for simple project management.
LEGO requires python3.6, virtualenv, docker and docker-compose. Services like Postgres, Redis, Elasticsearch, Thumbor and Minio run inside docker.
$ git clone git@github.com:webkom/lego.git && cd lego/
$ python3 -m venv venv
$ source venv/bin/activate
$ echo "from .development import *" > lego/settings/local.py
$ pip install -r requirements/dev.txt
$ docker-compose up -d
$ python manage.py initialize_development
$ python manage.py runserverThis codebase uses the PEP 8 code style. We enforce this with isort, yapf & flake8.
In addition to the standards outlined in PEP 8, we have a few guidelines
(see setup.cfg for more info):
- Line-length can exceed 79 characters, to 100, when convenient.
- Always use single-quoted strings (e.g. 'lego'), unless a single-quote occurs within the string.
Format the code with yapf in an editor plugin (eg. yapf-pycharm for pycharm and ale for vim), you can also run the following commands to format:
$ isort -rc lego # Sort imports
$ yapf -ir lego # Format with yapfTo check if it is formatted properly, run:
$ tox -e yapf
$ tox -e flake8
$ tox -e isortLego runs in Kubernetes and deploys are managed by Drone and Spinnaker.
How to deploy:
- Make sure the changes is pushed to master and the test passes.
- Have you added some new settings in
settings/? If so make sure the Spinnaker deployment reflects these changes. - We run migrations automatically, make sure they work!
- Push to the
prodbranch. From master:git push origin master:prod
Spinnaker now starts the deployment. This takes some time, tests must pass and we have to build a docker image.
We recommend Pycharm for development, use your @stud.ntnu.no email to register a free professional account.