documentation about components

This commit is contained in:
Johannes Lötzsch 2022-03-06 20:12:20 +01:00
parent 8e6a104193
commit d0b11c639a
1 changed files with 12 additions and 5 deletions

View File

@ -1,4 +1,4 @@
This repository contains tools for NGOs organizing private hosting.
This repository contains tools for NGOs, organizing private hosting.
## Import of existing datasets
@ -16,19 +16,26 @@ This repository contains tools for NGOs organizing private hosting.
## A secure / robust / scalable **backend**, usable by all NGOs
Every NGO can decide between self-hosting the backend or using a backend provided by us.
- [ ] nixos server deployment
- [ ] reproducible builds with nixpkgs
- [ ] xtdb
- [x] reproducible builds with nixpkgs
- [x] xtdb
- [x] graphql
Reuses the technology stack of [swlkup](https://github.com/johannesloetzsch/swlkup)
## A frontend for authorized NGO members, to **search** the database
- [ ] TODO
A website written for this use case allows easy input of filters. The usage of finding matches will be much more convenient than working with a spreadsheet.
- [ ] **Should be available this week** (work in progress)
## A customizable public form, to submit new offers
There is no need to use this component for NGOs happy with their existing solution.
There is no need to use this component for NGOs happy with their existing solution. Instead they can use the [import function or an API adapter](#import-of-existing-datasets).
A optional new form was requested by:
- [ ] zentralwerk & goethe institut
- [ ] lifeline