Development

Note

If not stated otherwise, the development documentation currently applies to all Ekklesia Python web apps, ekklesia-portal and ekklesia-voting. ekklesia-portal is used as an example in the documentation.

• Backend:

  • Main language: Python 3.10

  • Web framework: Morepath

  • Web API framework for ekklesia-notify: FastAPI

  • Testing: pytest, WebTest

• Frontend

  • Templates PyPugJS (similar to Pug) with Jinja as template engine.

  • Sass Framework Bootstrap 4

  • htmx for “AJAX” requests directly from HTML.

• Database: PostgreSQL 13

• Dependency management and build tool: Nix

• Documentation: Sphinx with MyST Markdown parser.

• (Optional) Docker / Kubernetes for running Docker images built by Nix

Contents

• Development Quick Start
• Development Environment
  • Install Nix
  • Install Lorri
  • Setting up nix-direnv
  • Setting up the Cachix Binary Cache
  • Running PostgreSQL as User
  • Updating The Development Environment
  • Editor / IDE Integration
• NixOS Virtualbox Dev VM
  • VM Preparation
  • Setting up the Project
  • Setting up Tests
• Concept Tutorial
  • Building Blocks
  • Generate a Concept
  • Test it
  • Extend it
• Testing
  • Setup
  • Running Tests
• Templates
  • HTML Tags and Attributes
    • Class and ID Literal
    • Values from Expressions
    • Boolean Attributes
    • Differences to Pug
  • Code
    • Buffered (With Output)
    • Unbuffered
  • Conditionals
  • Plain Text
    • Mixing Code with Text
  • Iteration
  • Comments
  • Code Style
• Stylesheets
  • Generate CSS
• Dependency Management
• Database
  • Setting up a Development Database
  • Running Migrations
  • Schema Changes and Migrations
• Code Style
  • Auto-Formatting Python Code
  • Style Tips
  • More About Code Style