FSFE Community Database Frontend https://my.fsfe.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Reinhard Müller 6d4a8d9993 Add some logging for email validation 6 days ago
doc Add documentation about hacking tools and conventions 1 month ago
fsfe_cd_front Add some logging for email validation 6 days ago
test Add some more automatic tests 1 month ago
.dockerignore Fix alphabetic order 1 month ago
.drone.yml Create a dedicated docker image for the quality check 1 month ago
.env Remove unnecessary "export" from .env 2 months ago
.gitignore Add automatic pytest coverage HTML statistic 3 months ago
.isort.cfg Clean up isort config 2 months ago
Dockerfile Update copyright headers 3 months ago
Dockerfile-quality Create a dedicated docker image for the quality check 1 month ago
LICENSE Update copyright headers 3 months ago
MANIFEST.in Actually install translations on target system 7 months ago
Makefile Remove unneccessary command line parameters 2 months ago
Pipfile Add email verification 6 days ago
Pipfile.lock Add email verification 6 days ago
README.md Add installation and deployment instructions 1 month ago
babel.cfg Update to a consistent project name of fsfe-cd-front 1 year ago
docker-compose-quality.yml Create a dedicated docker image for the quality check 1 month ago
docker-compose.yml Fix redis host 2 months ago
setup.py Clean up isort config 2 months ago

README.md

FSFE Community Database Frontend

The web user interface for the FSFE Community Database, visible through https://my.fsfe.org/

Introduction

The FSFE Community Database is a combined tool for donation management, administration of accounts for FSFE’s services, and opt-in based distribution of information emails.

All relevant data for these purposes is stored in a PostgreSQL database on the one hand and FSFE’s LDAP server on the other hand. Access to that data is encapsulated by the FSFE Community Database Backend (fsfe-cd-back), which provides both a set of commandline tools for manual administration tasks, and a protected RESTful(ish) network API to be used by other components.

The FSFE Community Database Authentication Server (fsfe-cd-auth) is an OpenID Connect Provider running on https://id.fsfe.org which authenticates a user against the LDAP server and then issues an access token which provides access to the authenticated user’s (and only the authenticated user’s) data though fsfe-cd-back’s API.

Finally, the FSFE Community Database Frontend is a web application through which the people stored in the database can manage their own data at https://my.fsfe.org. It sends users to fsfe-cd-auth to log in and then uses the user-bound access token returned from there to access the user’s data through fsfe-cd-back.

Overview

This repository contains the FSFE Community Database Frontend.

fsfe-cd-front is a web application built with Flask. It provides a number of endpoints (called “views” in Flask) of the following categories:

  1. Endpoints for interaction with the actual user: registering as a new user (register.py), paying online (payonline.py), logging in and out (login.py), and viewing as well as updating the personal settings (settings.py).

  2. Endpoints for handling predefined commands which can be executed by simply following a prepared link (command.py).

  3. Endpoints for the automatic registration of incoming payments through PayPal or ConCardis (register_payment.py)

Translations

Translations can be found in fsfe_cd_front/translations/. Almost all strings are available in on .po file which can be edited with tools like Poedit.

In order to create a new language, just create the language’s folder and an empty file messages.po, so for instance fsfe_cd_front/translations/es/LC_MESSAGES/messages.po. Afterwards, run make msgsupdate to fill this file with all strings used in the interface.

As soon as you have finished the translation, please run make msgscompile. You can now commit the two changed files.

The language displayed on my.fsfe.org is derived from your browser’s language setting.

FAQ translations

The source strings contain newslines (\n) and empty spaces. You don’t have to add those to your translation and can ignore such errors from Poedit.

Further reading

The directory doc contains more detailled documentation.