IGNIS

Appearance

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 ​

CheckAction
SecretsStore in environment variables, never in code
InputValidate with Zod schemas at API boundaries
AuthProtect routes with authStrategies: [Authentication.STRATEGY_JWT]
Sensitive dataUse hiddenProperties in model settings
File uploadsUse sanitizeFilename() for all user-provided filenames
CORSConfigure allowed origins explicitly

Performance Checklist ​

CheckAction
QueriesUse fields to select only needed columns
PaginationAlways set limit on find operations
RelationsLimit include depth to 2 levels max
Connection poolConfigure pool size based on load
Background jobsOffload CPU-intensive tasks to workers
CachingCache expensive queries with Redis

All Best Practices ​

Architecture & Design ​

GuideDescription
Architectural PatternsLayered architecture, DI, components, mixins
Architecture DecisionsWhen to use services, repositories, components

Development ​

GuideDescription
Code Style StandardsNaming conventions, types, ESLint, Prettier
Data ModelingSchema design, enrichers, relations, migrations
API Usage ExamplesRouting, repositories, middleware, services

Quality ​

GuideDescription
Testing StrategiesUnit tests, integration tests, mocking, E2E
Error HandlingError patterns, structured errors, logging
Common PitfallsMistakes to avoid and how to fix them
Troubleshooting TipsDebug common issues quickly

Production ​

GuideDescription
Security GuidelinesAuthentication, validation, secrets, CORS
Performance OptimizationQuery optimization, caching, connection pooling
Deployment StrategiesDocker, Kubernetes, cloud platforms, CI/CD

Contributing ​

GuideDescription
Contribution WorkflowGit workflow, PR guidelines, code review

New to Ignis?

Start with the Getting Started Guide for tutorials, then return here for production-ready patterns.

Production Deployment?

Before deploying, review the Security Guidelines and Deployment Strategies thoroughly.

See Also ​