How cyb0rgzz/code-kata works
Project Type and Purpose
• Even if the README is blank or minimal, try to discover the intent by examining additional sources: project description in version control, commit messages, or by discussing with stakeholders.
• Classify the project as one of the common types:
• Full-stack web application
• Microservice suite
• Open-source library or CLI tool
• Compiler or language processor
• Data pipeline or ETL system
• Record a one-sentence summary of the project’s goal (e.g., “This is a React-Node-Postgres e-commerce site”).
File Structure (to be done once you have details)
• Look for top-level directories:
• frontend, backend, services, cli, lib, cmd, scripts, docs, tests
• Configuration and orchestration files:
• Dockerfile, docker-compose.yml, Kubernetes manifests, Terraform, CI/CD scripts
• Notice language-specific patterns:
• src/main/java + src/test/java → Java/Maven
• cmd/, pkg/, internal/ → Go
• app/, config/, public/, routes/, models/ → Node/Express or Rails
• External integration points:
• auth (OAuth providers)
• messaging (Kafka, RabbitMQ)
• storage (S3, Redis, Elasticsearch)
Extract Architecture Notes from the README
• If the README describes a high-level architecture, copy the key phrases:
• “The frontend calls the backend REST API at /api/v1”
• “We use Pub/Sub to decouple services”
• “Compilation phases: parsing, semantic analysis, codegen”
a. Main Components
• Frontend (SPA, mobile app, CLI)
• Backend / API layer (monolith vs. microservices)
• Database(s) (SQL, NoSQL, search index)
• Caches, message brokers, external services
• Build or pipeline stages for compiler/ETL
b. Relationships & Interactions
• Message flow: Service A → message broker → Service B
• For compilers: Source code → Lexer → Parser → AST → Semantic Analyzer → IR → Code Generator
c. Architectural Patterns
• MVC or MVVM in frontend
• Layered architecture in backend (controller, service, repository)
• Event-driven or pub/sub microservices
• CI/CD pipeline stages (build → test → deploy)
d. Technologies & Frameworks
• React, Angular, Vue, Flutter
• Express, Spring Boot, Django, Go net/http
• PostgreSQL, MongoDB, Redis, Kafka, AWS S3
• Docker, Kubernetes, Terraform, GitHub Actions