📄️ 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.