mirror of
https://github.com/twentyhq/twenty
synced 2026-04-21 21:47:38 +00:00
5d438bb70c
## Summary - **New Getting Started section** with quickstart guide and restructured navigation - **Halftone-style illustrations** for User Guide and Developer introduction cards using a Canvas 2D filter script - **Removed hero images** (`image:` frontmatter + `<Frame><img>` blocks) from all user-guide article pages - **Cleaned up translations** (13 languages): removed hero images and updated introduction cards to use halftone style - **Cleaned up twenty-ui pages**: removed outdated hero images from component docs - **Deleted orphaned images**: `table.png`, `kanban.png` - **Developer page**: fixed duplicate icon, switched to 3-column layout ## Test plan - [ ] Verify docs site builds without errors - [ ] Check User Guide introduction page renders halftone card images in both light and dark mode - [ ] Check Developer introduction page renders 3-column layout with distinct icons - [ ] Confirm article pages no longer show hero images at the top - [ ] Spot-check a few translated pages to ensure hero images are removed 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: github-actions <github-actions@twenty.com>
77 lines
2 KiB
Text
77 lines
2 KiB
Text
---
|
|
title: Commands
|
|
icon: "terminal"
|
|
description: Useful commands for developing Twenty.
|
|
---
|
|
|
|
Commands can be run from the repository root using `npx nx`. Use `npx nx run {project}:{command}` for explicit targeting.
|
|
|
|
## Starting the App
|
|
|
|
```bash
|
|
npx nx start twenty-front # Frontend dev server (http://localhost:3001)
|
|
npx nx start twenty-server # Backend server (http://localhost:3000)
|
|
npx nx run twenty-server:worker # Background worker
|
|
```
|
|
|
|
## Database
|
|
|
|
```bash
|
|
npx nx database:reset twenty-server # Reset and seed database
|
|
npx nx run twenty-server:database:migrate:prod # Run migrations
|
|
npx nx run twenty-server:database:migrate:generate --name <name> --type <fast|slow> # Generate a migration
|
|
```
|
|
|
|
## Linting
|
|
|
|
```bash
|
|
npx nx lint:diff-with-main twenty-front # Lint changed files (fastest)
|
|
npx nx lint:diff-with-main twenty-server
|
|
npx nx lint twenty-front --configuration=fix # Auto-fix
|
|
```
|
|
|
|
## Type Checking
|
|
|
|
```bash
|
|
npx nx typecheck twenty-front
|
|
npx nx typecheck twenty-server
|
|
```
|
|
|
|
## Testing
|
|
|
|
```bash
|
|
# Frontend
|
|
npx nx test twenty-front # Jest unit tests
|
|
npx nx storybook:build twenty-front # Build Storybook
|
|
npx nx storybook:test twenty-front # Storybook tests
|
|
|
|
# Backend
|
|
npx nx run twenty-server:test:unit # Unit tests
|
|
npx nx run twenty-server:test:integration # Integration tests
|
|
npx nx run twenty-server:test:integration:with-db-reset # Integration with DB reset
|
|
|
|
# Single file (fastest)
|
|
npx jest path/to/test.test.ts --config=packages/{project}/jest.config.mjs
|
|
```
|
|
|
|
## GraphQL
|
|
|
|
```bash
|
|
npx nx run twenty-front:graphql:generate # Regenerate types
|
|
npx nx run twenty-front:graphql:generate --configuration=metadata # Metadata schema
|
|
```
|
|
|
|
## Translations
|
|
|
|
```bash
|
|
npx nx run twenty-front:lingui:extract # Extract strings
|
|
npx nx run twenty-front:lingui:compile # Compile translations
|
|
```
|
|
|
|
## Build
|
|
|
|
```bash
|
|
npx nx build twenty-shared # Must be built first
|
|
npx nx build twenty-front
|
|
npx nx build twenty-server
|
|
```
|