Technical Onboarding

Note: This document's purpose is meant to serve as a technical onboarding guide for new developers to the UIPA.org project. For a top level view of the project, consider starting here.

Overview

UIPA.org is powered by two main @CodeWithAloha repositories, CodeWithAloha/froide and CodeWithAloha/uipa. A quick diagram as to how these interact:

flowchart TD
    UIPA.org-- Custom Froide Theme -->uipa
    uipa-- Underlying Froide App -->froide

Loading

"Froide" (stemming from "Freedom of Information de", de for Germany), is a Freedom of Information portal software written in Python with Django. It uses a few built-in Django key features, such as an Admin interface to manage and update entities and user management and authentication. For more information about froide, check out the docs and/or the repository.

In simple terms, CodeWithAloha/froide is the core repo while CodeWithAloha/uipa applies a theme on top of it.

The current version of UIPA.org was forked from the Froide theme repository at https://github.com/okfde/froide-theme.