Skip to content

INDEX.md

Latest commit

 

History

History
198 lines (155 loc) · 6.34 KB

INDEX.md

File metadata and controls

198 lines (155 loc) · 6.34 KB
Raw

Repository Index

Complete GitHub repository for vibtellect/email-classification-routing created successfully.

Repository Overview

Project: KI-E-Mail-Klassifikation & Routing
Type: Proof of Concept (PoC)
Language: German (Deutsch)
License: MIT (2026 Bojatschkin LTD)
Repository: https://github.com/vibtellect/email-classification-routing

All Files in This Repository

Root Configuration Files

File Purpose Size
.env.example AWS credentials template + IMAP/Slack config Template
.gitignore Exclude secrets, node_modules, Docker volumes Security
docker-compose.yml Single-container setup (n8n 1.76 on port 5678) Config
Makefile Make targets: setup, up, down, logs, smoke, import Automation
LICENSE MIT License with proper copyright notice Legal

Documentation (1,076 lines total)

File Purpose Audience Key Sections
README.md Professional main documentation Everyone Architecture diagram, quickstart, API docs, tech stack, security notes
QUICKSTART.md 3-minute setup guide New users 6 simple steps to running the demo
CONTRIBUTING.md Contribution guidelines Developers Commit style, code style, PR process, issue templates
SECURITY.md Production deployment guide DevOps/Security Known limitations, production checklist, AWS best practices, incident response

Workflows

File Purpose Nodes
workflows/email-classification.json Complete n8n workflow 6 nodes (Webhook, Normalize, LLM Chain, Bedrock, Parse & Route, Response)

Prompts

File Purpose Content
prompts/email-classifier.txt System prompt for Bedrock Categories, priorities, sentiment, examples, rules (87 lines)

Test Emails (11 realistic examples)

All in test-emails/ directory:

Category Files Total
Anfrage (Inquiries) anfrage-klein.txt, anfrage-enterprise.txt 2
Beschwerde (Complaints) beschwerde.txt, beschwerde-lieferung.txt, support-technisch.txt 3
Bewerbung (Applications) bewerbung.txt, bewerbung-initiativ.txt 2
Rechnung (Invoices) rechnung.txt, rechnung-saas.txt 2
Spam spam-newsletter.txt 1
Partnership partnerschaft-anfrage.txt 1
Docs test-emails/README.md -

IAM & Security

File Purpose Permissions
iam/n8n-automation-policy.json AWS IAM policy (least privilege) Bedrock, S3, Lambda, CloudFormation, SES, SQS, SNS, CloudWatch, SSM

CI/CD

File Purpose Checks
.github/workflows/ci.yml GitHub Actions pipeline JSON validation, Docker Compose check, secrets scan, markdown checks

Quick Navigation

For First-Time Users

  1. Start with QUICKSTART.md (3 minutes)
  2. Read main README.md for architecture overview
  3. Try test emails from test-emails/README.md

For Developers

  1. See CONTRIBUTING.md for coding guidelines
  2. Check test-emails/README.md for testing procedures
  3. Review workflow in workflows/email-classification.json

For DevOps/Security

  1. Read SECURITY.md for production considerations
  2. Review iam/n8n-automation-policy.json
  3. Check .github/workflows/ci.yml for CI/CD setup

For Understanding Classification

  1. Categories: README.md#Kategorien & Routing
  2. Prompt details: prompts/email-classifier.txt
  3. Examples: test-emails/README.md

Key Statistics

  • Total Files: 25
  • Total Directories: 7
  • Documentation Lines: 1,076
  • JSON Files: 2 (all validated)
  • Test Emails: 11 (covering all categories)
  • Configuration Files: 4
  • Ready for GitHub: YES

File Categories

Must-Haves

  • ✓ README.md (professional, comprehensive)
  • ✓ LICENSE (MIT with attribution)
  • ✓ .gitignore (blocks .env, .aws, secrets)
  • ✓ docker-compose.yml (single command setup)
  • ✓ Makefile (helpful automation)

Nice-to-Haves

  • ✓ QUICKSTART.md (reduces friction)
  • ✓ CONTRIBUTING.md (encourages collaboration)
  • ✓ SECURITY.md (production guidance)
  • ✓ test-emails/ (easy testing)
  • ✓ .github/workflows/ci.yml (quality gates)

Repository Features

Documentation Quality

  • Clear, professional German writing
  • No English except where necessary (AWS, Docker, etc)
  • Comprehensive examples with curl commands
  • Architecture diagram in README
  • Production security guidelines included

User Experience

  • Single-command setup: make setup && make up
  • Health checks: make smoke
  • Live logs: make logs
  • 11 realistic test emails
  • curl examples for all categories

Code Quality

  • JSON syntax validated
  • Docker Compose validates
  • GitHub Actions CI/CD included
  • Security checks automated
  • Markdown linting in CI

Safety

  • MIT License clear
  • AWS credentials template (not actual keys)
  • .gitignore blocks secrets
  • SECURITY.md warns about PoC limitations
  • Least-privilege IAM policy

Webhook API Summary

POST http://localhost:5678/webhook/email-classification

Categories: anfrage, beschwerde, bewerbung, rechnung, spam
Priorities: hoch, mittel, niedrig
Routes: vertrieb, support, hr, buchhaltung, papierkorb, manuell-pruefen

Repository Size Estimate

  • Code/Config: ~50 KB
  • Documentation: ~200 KB
  • Test Emails: ~30 KB
  • Total: ~280 KB

Before Publishing to GitHub

  1. Create empty GitHub repo
  2. Add repository description
  3. Add topic tags: n8n, aws, bedrock, automation, german
  4. Enable branch protection (optional)
  5. Set up webhook secrets (optional)

File Validation Checklist

  • All JSON files valid (jq empty)
  • All markdown files present
  • .gitignore covers secrets
  • LICENSE included
  • docker-compose.yml complete
  • Makefile targets working
  • Test emails realistic
  • Documentation comprehensive
  • IAM policy least-privilege
  • CI/CD pipeline defined

Support & Links

License

MIT License 2026 Vitalij Bojatschkin / BOJATSCHKIN LTD

Repository Ready: YES Recommended Next Step: Push to GitHub

Created: 2026-03-05 Last Updated: 2026-03-05