Skip to content

schowave/churchtools-api

Repository files navigation

ChurchTools API

This repository provides a user-friendly interface to access the ChurchTools API.

It was created to fulfill the need of displaying all appointments from evkila.de on a single PDF file or as multiple JPEG images.

Features

Main Dashboard with Multiple Functions

Overview Dashboard

Calendar Selection

Select one or more public calendars to view and manage appointments: Calendar Selection

Export Options

Generate formatted PDF documents or JPEG images with customizable styling: Export Options

Output Example

Example of a generated appointment list: Result Example

Setup Instructions

Local Development Setup

  1. Create and activate a virtual environment:

    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
    pip install -r requirements.txt
  2. Edit the Dockerfile to configure your ChurchTools instance:

    ENV  CHURCHTOOLS_BASE=evkila.church.tools \
         DB_PATH=/app/data/evkila.db
  3. Run the application using the provided shell script:

    ./run.sh
  4. Access the application in your browser: http://127.0.0.1:5005/

Docker Deployment

To build and push a Docker image with the latest changes:

./build-and-push-docker-image.sh

This script will run all tests before building the Docker image to ensure code quality.

About

This repository makes it possible to access the churchtools api via User Interface.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •