个人 GitHub 账号下公开仓库的所有者可以登录并验证所有权,自行管理介绍,无需管理员批准。
登录并生成验证文件,在 30 分钟内将其提交到此仓库的默认分支。其他分支或分叉仓库中的文件无效。然后在下方检查文件,即可无需管理员批准直接管理项目。请保留文件以维持管理权限。
如需登录,将前往登录页面。登录后请回到此处,再次点击所选的验证按钮。
在项目文件夹中运行 /nomorevibe verify,即可验证所有权并自行管理介绍。
一分钟完成验证Transcribe and structure audio recordings into Markdown notes using Groq's Whisper + Llama 3 - FastAPI backend + React/Vite PWA, self-hosted on a Raspberry Pi
翻译准备中
取自仓库 README
正在加载完整 README。 以下为已保存的摘录。
🎓 Meetup Killer — AI Course Assistant
Meetup Killer turns audio recordings of lectures or meetings into structured Markdown study notes — or, if you just want the raw transcript, that too. Built to run on a Raspberry Pi, deployed via Docker, exposed publicly through a Cloudflare Tunnel — no port forwarding. Heavy processing is offloaded to the Groq API (Whisper Large V3 for transcription, GPT-OSS 120B for structuring).查看完整 README ↗🚀 Live service: parseandcut.alithiel31.dev
Meetup Killer turns audio recordings of lectures or meetings into structured Markdown study notes — or, if you just want the raw transcript, that too. Built to run on a Raspberry Pi, deployed via Docker, exposed publicly through a Cloudflare Tunnel — no port forwarding. Heavy processing is offloaded to the Groq API (Whisper Large V3 for transcription, GPT-OSS 120B for structuring).
This project covers, end to end:
frontend/ — React + Vite Progressive Web App, packaged as a TWA (Trusted Web Activity) for Androiddocker context, Cloudflare Tunnel for HTTPS/public access with no port forwarding — see docs/DEPLOY_PI.md/health, /api/transcribe/start error paths) on every push/PRdocs/Troubleshooting.md| Feature | Detail |
|---|---|
| 🎙️ Long audio support | Auto-split into 10-min chunks — handles recordings over 1 hour |
| 🧠 Structured notes | Summary, hierarchical headings, bold keywords, definition blocks |
| 🔀 Two output modes | Pick AI summary or raw transcript per upload — transcript mode skips the LLM call entirely, and comes with per-segment timestamps |
| 🌐 Modern UI | Drag & drop, step-by-step progress bar, processing stats |
| 🇫🇷🇬🇧 French/English UI | Language switcher (header), translates the whole flow and the legal pages; drives the LLM structuring prompt's output language too — independent of Whisper, which always auto-detects the spoken language |
| 🔔 Local notifications | Opt-in "notify me when done" — pings the device via the service worker once a transcription finishes, useful when the tab is backgrounded |
| ✅ Robust validation | File type + size checked both client-side and server-side (100 MB max — Cloudflare's own proxy ceiling on Free/Pro, see docs/Troubleshooting.md) |
| 🔁 Auto retry | Whisper retried on network timeout with exponential backoff |
| 🐳 Docker ready | FFmpeg + Uvicorn pre-configured, lightweight python:3.10-slim image |
📊 /health endpoint | Monitoring: Groq status, default output language, supported formats |
| ⚖️ Legal pages | Terms, privacy policy and legal notice served by the PWA (/cgu, /politique-de-confidentialite, /mentions-legales), each in French and English |
mp3 · mp4 · wav · m4a · ogg · webm · flac · aac · opus
flowchart LR
U["User (browser / TWA)"] -->|upload audio| FE
subgraph Pi["Raspberry Pi (Docker Compose)"]
TRA["Traefik<br/>reverse proxy · :8000"]
FE["frontend container<br/>nginx · frontend/<br/>traefik-net"]
BE["backend container<br/>FastAPI + Uvicorn<br/>:5000 (internal only)"]
TRA -->|"Host: parseandcut.alithiel31.dev"| FE
FE -->|reverse-proxy /api/*| BE
end
BE -->|FFmpeg| CHUNK["10-min chunks"]
CHUNK -->|Whisper Large V3| TXT["raw transcription"]
TXT -->|"mode=summary"<br/>GPT-OSS 120B| MD["structured Markdown"]
TXT -->|"mode=transcript"| RAW["raw transcript returned as-is"]
TUN["Cloudflare Tunnel<br/>parseandcut.alithiel31.dev"] --> TRA
U -.->|public access| TUN
Nginx (frontend container) serves the PWA static files and reverse-proxies /api/ to the backend — same-origin, no CORS to manage in production. Traefik (shared reverse proxy on the Pi) routes the public hostname to the frontend container via traefik-net, without exposing a dedicated port on the host. The Cloudflare Tunnel handles HTTPS and the domain name — no certificate to manage manually, no port opened on the router.
| Variable | Required | Default | Description |
|---|---|---|---|
GROQ_API_KEY | ✅ | — | Groq API key (console.groq.com) |
LANGUAGE | ❌ | fr | Default output language (fr/en) used when a request omits lang — does not force Whisper's input language, which always auto-detects |
PORT | ❌ | 5000 | Port the backend listens on |
CHUNK_DURATION_SEC | ❌ | 600 | Chunk duration in seconds |
FFMPEG_PATH | ❌ | ffmpeg | Path to the FFmpeg binary |
CORS_ORIGINS | ❌ | https://parseandcut.alithiel31.dev | Comma-separated allowed origins — override for local dev (Vite on :5173 calling Uvicorn on :5000) |
MAX_UPLOAD_SIZE_MB | ❌ | 100 | Max upload size enforced by the backend (in addition to nginx's client_max_body_size) — matches Cloudflare's own proxy ceiling on Free/Pro plans |
RATE_LIMIT_PROCESS | ❌ | 5/minute | Rate limit on /api/transcribe/start and on creating/finishing a segmented recording (per IP), format N/period |
RATE_LIMIT_SEGMENTS | ❌ | 60/minute | Rate limit on segment uploads of a segmented recording (per IP, shared by all segments) |
RECORDING_SEGMENT_SEC | ❌ | 300 | Length of one recording segment, announced to the browser |
RECORDING_EARLY_TRANSCRIPTION | ❌ | 1 | Transcribe each segment as soon as it arrives, while the meeting is still running (0 to process everything at the end) |
Production note: on the Caesura deployment,
GROQ_API_KEYis not read from.env— it's injected at deploy time via Infisical (seedocs/DEPLOY_PI.md). For local development, set it directly in your.envas described below.
Clone the repository
git clone https://github.com/Alithiel31/ParseAndCutV2.git
cd ParseAndCutV2
Create your .env file
cp ".env exemple" .env
Fill in GROQ_API_KEY at minimum.
Run with Docker
docker build -t meetup-killer .
docker run -d -p 5000:5000 --name meetup-app --env-file .env meetup-killer
Or without Docker (Python 3.10 + FFmpeg installed locally):
pip install -r requirements.txt
python -m app.main
Open the app at http://localhost:5000
On Raspberry Pi, replace
localhostwith the device's local IP address.
This is the production setup. This repo's docker-compose.yml runs the backend (internal network, port 5000) and the frontend/ PWA (nginx, routed via Traefik on traefik-net, no port exposed on the host) — see docs/DEPLOY_PI.md for the full procedure (creating the docker context to the Pi, building, configuring the Traefik labels and the Cloudflare ingress).
docker context use rpi
docker compose build
bash deploy.sh
Check the /health endpoint anytime to verify service status.
# Linting — same checks as the lint.yml workflow
npm run lint # flake8 (backend)
cd frontend && npm run lint # oxlint (frontend)
# Unit tests (FastAPI routes mocked against FFmpeg/Groq) — same as the integration.yml workflow
pytest
Two workflows run on every push/PR to main:
.github/workflows/lint.yml): flake8 (backend), oxlint (frontend).github/workflows/integration.yml): runs the pytest suite, then boots the FastAPI app and checks /, /health, and the /api/transcribe/start error paths (missing file → 400, unsupported format → 415)This project follows Semantic Versioning (MAJOR.MINOR.PATCH) and Keep a Changelog. Every notable change lands in CHANGELOG.md under [Unreleased] first, then under a version heading once tagged:
git tag -a vX.Y.Z -m "vX.Y.Z"
git push origin vX.Y.Z
A GitHub Release is then created from the tag, with its description copied from the matching CHANGELOG.md section.
| Guide | Content |
|---|---|
docs/architecture.md | Asynchronous job model, processing pipeline, segmented recording, security layers, repository structure |
docs/environment.md | Every environment variable, hard-coded constants, deployment and CI secrets |
docs/development.md | Run it locally, routes and error codes, tests, CI |
docs/DEPLOY_PI.md | Docker context, Traefik, Cloudflare ingress, Infisical |
docs/handover-guide.md | What runs where, which accesses are needed, how to rebuild from scratch, known risks |
docs/Troubleshooting.md | Incidents already encountered, with the diagnostic process |
docs/CONTRIBUTING.md · docs/SECURITY.md · docs/SUPPORT.md · docs/CODE_OF_CONDUCT.md | Community files |
Each guide has a French version (*.fr.md).
See docs/CONTRIBUTING.md for the development environment, how to reproduce the CI checks locally, and the PR/release format.
See docs/SECURITY.md to report a vulnerability.
MIT (see license field in package.json).
MAX_SEGMENT_SIZE_MB | ❌ | 50 | Max size of one uploaded segment |
MAX_RECORDING_SIZE_MB | ❌ | 300 | Max cumulated size of all segments of one recording |
MAX_SEGMENTS | ❌ | 500 | Max number of segments in one recording |
FLASK_DEBUG | ❌ | false | Debug mode (dev only) |