# Best Practices Production-ready patterns, security guidelines, and optimization strategies for building robust Ignis applications. These best practices are distilled from real-world experience building enterprise applications.

Architecture

Layered architecture, DI, components, lifecycle hooks

Code Standards

Naming, types, patterns, ESLint, Prettier

Security

Auth, validation, secrets, CORS, rate limiting

Data Modeling

Schemas, enrichers, relations, migrations

Testing

Unit tests, integration tests, mocking

Performance

Query optimization, caching, pooling

Error Handling

Error patterns, logging, user-friendly messages

Deployment

Docker, Kubernetes, cloud platforms, CI/CD
## Learning Path
1

Foundation

Architecture → Decisions Guide → Code Standards

Understand patterns and establish coding conventions
2

Data Layer

Data Modeling → API Patterns → Error Handling

Design your data layer and handle edge cases
3

Quality Assurance

Testing → Avoid Pitfalls → Troubleshooting

Write tests and prevent common mistakes
4

Production Ready

Security → Performance → Deployment

Secure, optimize, and deploy your application
## Quick Reference ### Essential Patterns ```typescript // ✅ Layered Architecture Controller → Service → Repository → DataSource // ✅ Dependency Injection @inject({ key: BindingKeys.build({ namespace: BindingNamespaces.SERVICE, key: UserService.name }) }) // ✅ Error Handling throw getError({ statusCode: 404, message: 'User not found' }); // ✅ Input Validation request: { body: jsonContent({ schema: z.object({ email: z.string().email() }) }) } ``` ### Anti-Patterns to Avoid ```typescript // ❌ Business logic in controllers @get({ configs: RouteConfigs.GET_USER }) async getUser(c: Context) { const user = await this.userRepo.findById(id); if (user.lastLogin < cutoff) await this.sendReminder(user); // Move to service! return c.json(user); } // ❌ Catching all errors silently try { await riskyOperation(); } catch (e) { /* swallowed */ } // ❌ Using `any` type const data: any = await fetchData(); // Use proper types! ``` ### Security Checklist | Check | Action | |-------|--------| | Secrets | Store in environment variables, never in code | | Input | Validate with Zod schemas at API boundaries | | Auth | Protect routes with `authStrategies: [Authentication.STRATEGY_JWT]` | | Sensitive data | Use `hiddenProperties` in model settings | | File uploads | Use `sanitizeFilename()` for all user-provided filenames | | CORS | Configure allowed origins explicitly | ### Performance Checklist | Check | Action | |-------|--------| | Queries | Use `fields` to select only needed columns | | Pagination | Always set `limit` on find operations | | Relations | Limit `include` depth to 2 levels max | | Connection pool | Configure pool size based on load | | Background jobs | Offload CPU-intensive tasks to workers | | Caching | Cache expensive queries with Redis | ## All Best Practices ### Architecture & Design | Guide | Description | |-------|-------------| | [Architectural Patterns](./architectural-patterns) | Layered architecture, DI, components, mixins | | [Architecture Decisions](./architecture-decisions) | When to use services, repositories, components | ### Development | Guide | Description | |-------|-------------| | [Code Style Standards](./code-style-standards/) | Naming conventions, types, ESLint, Prettier | | [Data Modeling](./data-modeling) | Schema design, enrichers, relations, migrations | | [API Usage Examples](./api-usage-examples) | Routing, repositories, middleware, services | ### Quality | Guide | Description | |-------|-------------| | [Testing Strategies](./testing-strategies) | Unit tests, integration tests, mocking, E2E | | [Error Handling](./error-handling) | Error patterns, structured errors, logging | | [Common Pitfalls](./common-pitfalls) | Mistakes to avoid and how to fix them | | [Troubleshooting Tips](./troubleshooting-tips) | Debug common issues quickly | ### Production | Guide | Description | |-------|-------------| | [Security Guidelines](./security-guidelines) | Authentication, validation, secrets, CORS | | [Performance Optimization](./performance-optimization) | Query optimization, caching, connection pooling | | [Deployment Strategies](./deployment-strategies) | Docker, Kubernetes, cloud platforms, CI/CD | ### Contributing | Guide | Description | |-------|-------------| | [Contribution Workflow](./contribution-workflow) | Git workflow, PR guidelines, code review | > [!TIP] New to Ignis? > Start with the [Getting Started Guide](/guides/) for tutorials, then return here for production-ready patterns. > [!WARNING] Production Deployment? > Before deploying, review the [Security Guidelines](./security-guidelines) and [Deployment Strategies](./deployment-strategies) thoroughly. ## See Also - [Getting Started](/guides/) - New to Ignis? Start here - [API Reference](/references/) - Detailed API documentation - [Core Concepts](/guides/core-concepts/application/) - Deep dive into architecture - [Changelogs](/changelogs/) - Version history and updates