Architecture Overview

This project follows a clean, modular architecture inspired by Domain-Driven Design (DDD) principles, focused on performance and developer productivity using TypeScript and Bun.

Technology Stack

Press enter or space to select a node. You can then use the arrow keys to move the node around. You can then use the arrow keys to move the node around, press delete to remove it and press escape to cancel.

Press enter or space to select an edge. You can then press delete to remove it or press escape to cancel.

Layer Overview

Press enter or space to select a node. You can then use the arrow keys to move the node around. You can then use the arrow keys to move the node around, press delete to remove it and press escape to cancel.

Press enter or space to select an edge. You can then press delete to remove it or press escape to cancel.

1. Commands (src/commands/)

The entry point of the application. It handles process management (via PM2), building, and bootstrapping. It also hosts the Zero-Dep Template Engine for domain scaffolding.

2. Domain (src/domain/)

The heart of the application. Each subfolder (e.g., user) represents a bounded context and contains:

• actions: The actually business logic handlers.
• entity: Data models and database table definitions.
• schema: Input validation and output serialization using Zod.
• routes: Fastify route definitions.

3. Infrastructure (src/infrastructure/)

Contains implementation details of technical services:

• Server: Fastify (HTTP) and WebSockets (Scalable) configurations.
• Cache: Redis integration for high-performance data storage with Graceful Degradation for high availability.
• Repository: Database connection and base repository patterns.
• Messages: Communication layer (distributed via Redis or internal via Node events).
• Plugins: Agent system for modular extensions (e.g., Authentication).

Request Flow

When an HTTP request arrives, it follows this path:

1. Fastify Server (Infrastructure) receives the request.
2. Request Transform converts raw data and identifies the language/token.
3. Route (Domain) matches the path and calls the appropriate Action.
4. Action (Domain) validates input using Schema (Domain/Zod).
5. Action interacts with Repository or Cache (Infrastructure) to fetch/persist data.
6. Action returns the response, which is then serialized by the Route.

Press enter or space to select a node. You can then use the arrow keys to move the node around. You can then use the arrow keys to move the node around, press delete to remove it and press escape to cancel.

Press enter or space to select an edge. You can then press delete to remove it or press escape to cancel.

Future Roadmap

We are constantly evolving the boilerplate to provide the best developer experience. Here is our current roadmap:

Press enter or space to select a node. You can then use the arrow keys to move the node around. You can then use the arrow keys to move the node around, press delete to remove it and press escape to cancel.

Press enter or space to select an edge. You can then press delete to remove it or press escape to cancel.

Phase 1: Core Architecture (Completed)

• [x] Zero-Dep Template Engine
• [x] Auto-CRUD Scaffolding
• [x] Redis-powered Smart Caching
• [x] i18n support

Phase 2: Enhanced Plugins ( In Progress)

• [x] Redis Graceful Degradation
• [x] Real-time WebSocket plugin (Scalable via Redis)
• [ ] Advanced Authentication (OAuth2, OIDC)
• [ ] Distributed Locking system

Phase 3: Advanced Observability (Planned)

• [ ] OpenTelemetry integration
• [ ] Structured logging with automatic trace correlation
• [ ] Performance monitoring dashboard

Phase 4: Cloud Native (Planned)

• [ ] Kubernetes operators for domain scaling
• [ ] Serverless deployment adapters
• [ ] Edge runtime optimization