Developers Guide

Conventions

Rules and guidelines on syntax style, development process, repository workflow, etc.

• Conventions
  • Line length
  • About imports
  • Sort imports
  • Commit checklist
  • Unit tests
  • Syntax validation
  • Changelog
  • Sphinx Documentation
  • Travis Continuous Integration
  • Git workflow & branching model

Local development environment

Setting up and using the local development environment.

• Local development environment
  • Prerequisites
  • Creating the development environment
  • Starting the portal
  • Adding initial content
  • Working on an issue

Remote development environment

Description of the remote development environment and how to use it for remote development in cases when local development environment is not feasible.

• Remote development environment

Staging environment

Description of our staging environment and how to deploy code to staging.

• Staging environment
  • Auto-deploying to staging

Production environment

Description of our production environment and how to deploy code to production.

• Production environment
  • Auto-deploying to production
  • Deployment checklist
  • Reverting a bad deployment

Tips & tricks

Random development and deployment tips & tricks.

• Tips & Tricks
  • Tunneling to ETHZ server
  • Setting up Git

Source documentation

List of all Python modules in the eestec.portal package and their inline documentation.

• Source Documentation