๐๏ธ 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.