ποΈ Development Guide
Getting started with Ever Gauzy development including environment setup, tooling, and best practices.
ποΈ Coding Standards
Code style and conventions for the Ever Gauzy codebase.
ποΈ Testing
Testing strategies for the Ever Gauzy backend.
ποΈ Plugin System
Ever Gauzy supports a plugin architecture for extending functionality.
ποΈ Environment Variables Reference
Complete reference for all environment variables in Ever Gauzy.
ποΈ Contributing
How to contribute to the Ever Gauzy project.
ποΈ Debugging
Tips and tools for debugging Ever Gauzy applications.
ποΈ CQRS & Event Handlers
Command Query Responsibility Segregation pattern in Ever Gauzy.
ποΈ API Documentation (Swagger)
Auto-generated API documentation using Swagger/OpenAPI.
ποΈ Feature Flags
Control feature visibility and availability through feature flags.
ποΈ Tenant Bypass Exceptions
This document catalogs all locations in the codebase where data access intentionally bypasses the automatic tenantId scoping
ποΈ API Versioning
API versioning strategy, deprecation policies, and migration guidance.
ποΈ Testing Strategy
Unit, integration, and end-to-end testing approaches for Ever Gauzy.
ποΈ E2E Testing with Playwright
End-to-end testing for the Gauzy web application.
ποΈ API Testing Guide
Test API endpoints using Jest, Supertest, and HTTP clients.
ποΈ Git Workflow & Branching Strategy
Git branching model and contribution workflow for Ever Gauzy.
ποΈ Monorepo Navigation Guide
Navigate the Ever Gauzy NX monorepo structure efficiently.
ποΈ Release Process
How releases are prepared, tested, and published.
ποΈ Dependency Management
Managing NPM dependencies, security auditing, and version strategies.
ποΈ Code Scaffolding & Generation
Generate boilerplate code for new modules, entities, and services.
ποΈ Code Review Checklist
Guidelines for reviewing pull requests in the Ever Gauzy codebase.