The FSFE's Community Database and all its related components
Go to file
Reinhard Müller 873d472031 Merge branch 'production' of git.fsfe.org:fsfe-system-hackers/fsfe-cd into production 2022-12-06 08:58:36 +01:00
auth Also remove setuptools install from quality images 2022-11-28 10:06:17 +01:00
back Adapt test to new `initdb.py` 2022-12-01 21:43:02 +01:00
front Update translation files 2022-12-06 08:58:04 +01:00
ldap-mock Refactor database initialisation 2021-11-17 22:53:58 +01:00
openpgp-ca avoid empty entrypoint to keep cache 2022-02-18 14:20:13 +01:00
.drone.yml Update docker 2022-11-22 14:16:56 +01:00
.pre-commit-config.yaml Remove `update-requirements-files` from pre-commit 2022-11-18 09:54:28 +01:00
Makefile Readd removal of `back/test.db` before test suite 2022-11-21 14:37:30 +01:00
README.md Add badges as HTML 2022-09-27 18:27:52 +02:00
docker-compose.development.yml Add PostgreSQL to dev env 2022-11-10 11:10:35 +01:00
docker-compose.production.yml Remove max.mehl from MAIL_DEFAULT_RECEIVERS 2022-11-22 12:46:17 +01:00
docker-compose.quality.yml Run quality checks as root when running in drone 2021-11-17 13:35:07 +01:00
docker-compose.staging.yml only send to alice per default 2022-03-14 12:21:21 +01:00
renovate.json (renovate) Ignore auto-generated `.txt` files 2022-05-16 12:14:22 +02:00

README.md

FSFE Community Database

Staging
Production

Background

Development

Prerequisites

The development of the FSFE Community Database is based on docker and docker-compose. Please note that this has been more tested against a rootless Docker daemon and since we run this type of daemon in both staging and production environments, it is recommended you have the same daemon running on your local machine. Here are Docker's installation instructions. Along with a text editor, these are the only two hard dependencies you need to have installed in order to start developing.

If you want to contribute, you also need pipenv and pre-commit installed locally. After installing pre-commit, you need to run

pre-commit install

in order to set up the check to run before every commit.

Start the development containers

Once you have them, run

make dev

to start all three modules, i.e. back, front and auth in unison. The corresponding directories in this repository are mounted inside these containers so you can start changing the code in one of them, and the apps will update automatically during runtime as they all run the built-in Flask debugging server. Once you're done with your changes run

make qc.all

before committing as the commands run by this rule will need to complete without errors in order to pass through our CI system.

If you want to find out what other commands are available via the Makefile, run

make

to display a small manual page.

Deployment

Staging

Production

Maintainers

@reinhard @max @linus

Contributing

Small note: If editing the README, please conform to the standard-readme specification.

License

AGPL-3.0-or-later © 2021 FSFE System Hackers