README.md

The Project

The Project is an AI-oriented starter kit for building scalable API

Quick Start

• Open docs/ folder, edit project desciption and starter prompt in docs/START.md.
• Optional: Configure the project for your goal by editing docs/*.md
• Use starter prompt in your favorite Vibe-code editor.

Project Map

Most .md files are written in a declarative style, with a clear focus on use by AI agents.

• AGENTS.md - agent constitution and rules
• CLAUDE.md, GEMINI.md - symlinks to AGENTS.md
• docs/API.md - API contracts
• docs/CONTAINERS.md - containers architecture
• docs/ENVIRONMENTS.md - environments config
• docs/EVENTS_AND_MESSAGES.md - events and messaging flow
• docs/FILES.md - files architecture
• docs/LLM_APIS.md - LLM API integrations
• docs/LOCAL_TO_PRODUCTION_PIPELINE.md - delivery pipeline
• docs/METRICS_AND_VISUALISATION.md - metrics and dashboards
• docs/NOTIFICATIONS.md - notifications architecture
• docs/PAYMENT_SYSTEM_AND_MONETIZATION.md - payments and monetization
• docs/PROJECT_CONTEXT.md - product additional context
• docs/SETUP.md - setup guide
• docs/START.md - starter prompt
• docs/STORAGE.md - storage design
• docs/TESTS.md - testing strategy