Home

Welcome to Gieß den Kiez Wiki! This documentation should help you set up your own Gieß den Kiez and understand the different parts that compose it.

If you are a developer, read the README_DEV.md file for a step-to-step guide that explains how to setup the project.

The project is split into four different repositories, roughly organised in Backend, Frontend and Data Harvesters.

• Frontend
• Backend / Database
• DWD Harvester
• Pumpen Harvester

This Wiki is a more high-level explanation of the project.

A. Set up Accounts

First and foremost, we encourage you to setup a GitHub Account to fork all our repositories and work on your own version of Gieß den Kiez. By doing so, you can pull the latest improvements from our upstream repository while we can keep the latest improvements from your side. Follow the spirit of the open source community and work open 👾

To make Gieß den Kiez work properly (on your local machine), you need to set up accounts at the following external providers:

1. Setup Mapbox
2. Setup Supabase
3. Setup Vercel (optional, for deploying the Frontend)
4. Setup Pipedream (optional, for scheduling Github Actions)

B. Set up the Backend

1. Configure Supabase
2. Setup Your DWD Harvester
3. Setup Your OSM Harvester

C. Setup the Frontend

1. Setup & Installation
2. Configuration files
3. Testing & Code Quality
4. Deploying on Vercel