📚 Reference
Monorepo Workspace Guide
Navigate and work within the Gauzy NX monorepo.
Workspace Layout
ever-gauzy/
├── apps/
│ ├── gauzy/ ← Angular web app
│ ├── api/ ← NestJS API server
│ ├── desktop/ ← Electron desktop app
│ ├── desktop-timer/ ← Desktop timer variant
│ └── server/ ← Electron server
├── packages/
│ ├── core/ ← Core API library
│ ├── auth/ ← Authentication
│ ├── common/ ← Shared types & utils
│ ├── config/ ← Configuration
│ ├── contracts/ ← TypeScript interfaces
│ └── plugins/ ← Plugin packages
│ ├── integration-ai/
│ ├── integration-github/
│ └── ...
├── libs/
│ ├── ui-core/ ← Angular shared UI
│ └── desktop-libs/ ← Desktop shared libs
├── nx.json
├── workspace.json
└── package.jsonKey Commands
| Command | Description |
|---|---|
yarn start:api | Start API (dev) |
yarn start | Start web app (dev) |
yarn build:api | Build API |
yarn build | Build web app |
yarn test | Run all tests |
yarn lint | Lint all packages |
NX Commands
# Run specific project target
npx nx run api:build
# Affected builds (only changed)
npx nx affected:build
# Dependency graph
npx nx graph
# List all projects
npx nx show projectsPackage Dependencies
Diagram source
graph TB
API[apps/api] --> Core[packages/core]
API --> Auth[packages/auth]
Core --> Common[packages/common]
Core --> Config[packages/config]
Core --> Contracts[packages/contracts]
Common --> Contracts
Web[apps/gauzy] --> UICore[libs/ui-core]
UICore --> ContractsRelated Pages
- Development Guide — setup
- Git Workflow — branching
- Dependency Management — deps