Ga naar hoofdinhoud

Monorepo Navigation Guide

Navigate the Ever Gauzy NX monorepo structure efficiently.

Repository Structure​

ever-gauzy/
β”œβ”€β”€ apps/ # Applications
β”‚ β”œβ”€β”€ gauzy/ # Angular web app (main UI)
β”‚ β”œβ”€β”€ api/ # NestJS API server
β”‚ β”œβ”€β”€ server-api/ # API standalone server
β”‚ β”œβ”€β”€ desktop/ # Electron desktop app
β”‚ β”œβ”€β”€ desktop-timer/ # Desktop timer app
β”‚ └── ...
β”œβ”€β”€ packages/ # Shared packages
β”‚ β”œβ”€β”€ core/ # Core API module (entities, services, controllers)
β”‚ β”œβ”€β”€ contracts/ # Shared TypeScript interfaces
β”‚ β”œβ”€β”€ common/ # Common utilities
β”‚ β”œβ”€β”€ config/ # Configuration
β”‚ β”œβ”€β”€ auth/ # Authentication module
β”‚ β”œβ”€β”€ plugin/ # Plugin infrastructure
β”‚ └── plugins/ # Built-in plugins
β”‚ β”œβ”€β”€ changelog/
β”‚ β”œβ”€β”€ knowledge-base/
β”‚ β”œβ”€β”€ integration-ai/
β”‚ └── ...
β”œβ”€β”€ libs/ # Shared libraries
β”‚ β”œβ”€β”€ ui-core/ # Core UI components
β”‚ └── ...
└── tools/ # Build tools & scripts

Key Directories​

DirectoryContentsKey Files
packages/core/src/libAll API modulesControllers, services
packages/contractsTypeScript interfacessrc/lib/*.model.ts
apps/gauzy/srcAngular frontendComponents, modules
packages/pluginsPlugin implementationsModule, entity files

Useful NX Commands​

# List all projects
npx nx show projects

# Dependency graph
npx nx graph

# Run specific project
npx nx serve api
npx nx serve gauzy

# Build specific project
npx nx build api --configuration=production

# Run tests for a project
npx nx test core

# Affected projects (changes since main)
npx nx affected --target=build

Finding Code​

Looking ForWhere to Look
API endpointpackages/core/src/lib/{feature}/
Entity definitionpackages/core/src/lib/{feature}/*.entity.ts
TypeScript interfacepackages/contracts/src/lib/
Angular componentapps/gauzy/src/app/pages/
Pluginpackages/plugins/{plugin-name}/
Shared servicepackages/common/src/lib/