History

Frederik Beimgraben 4ca18da706 Filters and Bulk Actions		2025-09-01 19:42:00 +02:00
..
features	Filters and Bulk Actions	2025-09-01 19:42:00 +02:00
API_REFERENCE.md	Neatly packaged for docker	2025-09-01 05:00:02 +02:00
ARCHITECTURE.md	Neatly packaged for docker	2025-09-01 05:00:02 +02:00
ATTACHMENT_FEATURE.md	Neatly packaged for docker	2025-09-01 05:00:02 +02:00
COMPARISON_OFFERS_FEATURE.md	Neatly packaged for docker	2025-09-01 05:00:02 +02:00
CONFIGURATION.md	Neatly packaged for docker	2025-09-01 05:00:02 +02:00
DEVELOPMENT.md	Neatly packaged for docker	2025-09-01 05:00:02 +02:00
INSTALLATION.md	Neatly packaged for docker	2025-09-01 05:00:02 +02:00
PDF_INTEGRATION.md	LaTeX dynamic building	2025-09-01 14:26:38 +02:00
QUICK_START.md	Neatly packaged for docker	2025-09-01 05:00:02 +02:00
README.md	LaTeX dynamic building	2025-09-01 14:26:38 +02:00

README.md

STUPA PDF API Documentation

Welcome to the STUPA PDF API documentation. This directory contains comprehensive documentation for the STUPA PDF API system, which handles PDF processing, form filling, and application management for student parliament funding applications.

Documentation Structure

📚 Main Documentation

Architecture Overview - System architecture, components, and design decisions
API Reference - Complete API endpoint documentation
Frontend Guide - Frontend development and usage guide
Database Schema - Database structure and relationships

🚀 Getting Started

Installation Guide - Step-by-step installation instructions
Configuration Guide - Environment variables and configuration options
Quick Start - Get up and running quickly

💻 Development

Development Guide - Development workflow and best practices
Contributing Guide - How to contribute to the project
Testing Guide - Testing strategies and procedures

🔧 Features

Attachment Feature - File attachment functionality
Comparison Offers Feature - Managing comparison offers
PDF Processing - PDF generation and parsing
PDF Integration - LaTeX templates and PDF form integration

🚢 Deployment

Deployment Guide - Production deployment instructions
Docker Guide - Docker configuration and usage
Security Guide - Security best practices and considerations

🔍 Troubleshooting

FAQ - Frequently asked questions
Troubleshooting Guide - Common issues and solutions
Migration Guide - Database migration procedures

Quick Links

API Base URL: http://localhost:8000 (development)
Frontend URL: http://localhost:3000 (development)
Database UI (Adminer): http://localhost:8080 (development)

Project Overview

The STUPA PDF API is a comprehensive system for managing student parliament funding applications. It provides:

PDF Processing: Parse uploaded PDFs and extract structured data
Form Generation: Generate filled PDF forms from application data
Application Management: Create, read, update, and delete applications
File Attachments: Upload and manage supporting documents
Comparison Offers: Manage comparison offers for cost positions
Authentication: Secure access with application keys and master keys
Rate Limiting: Protect against abuse with configurable rate limits

Technology Stack

Backend

FastAPI - Modern Python web framework
SQLAlchemy - SQL toolkit and ORM
MySQL - Relational database
PyPDF2 - PDF processing
Python 3.11 - Programming language

Frontend

React 18 - UI library
TypeScript - Type-safe JavaScript
Material-UI - Component library
Zustand - State management
Vite - Build tool

Infrastructure

Docker - Containerization
Docker Compose - Multi-container orchestration
Nginx - Web server and reverse proxy

Getting Help

Check the relevant documentation section
Search the FAQ
Look through the Troubleshooting Guide
Create an issue in the project repository

Documentation Updates

This documentation is actively maintained. If you find any errors or areas that need improvement, please:

Check the Contributing Guide
Submit a pull request with your improvements
Or create an issue describing what needs to be updated

Last updated: 2024