Project structure
Development workflow
1. Create a feature branch
2. Make changes
Follow the existing code style:- TypeScript for all code
- Prettier formatting (2 spaces, single quotes)
- ESLint rules from
next/core-web-vitals
3. Run quality checks
4. Commit and push
5. Create a pull request
PRs should include:- Summary of changes
- Testing notes
- Screenshots (for UI changes)
Code style
TypeScript
- Prefer
constoverlet - Use explicit return types for exported functions
- Document complex logic with comments
React
- Functional components with hooks
- PascalCase for components
- camelCase for hooks and utilities
Tailwind
Order classes: layout → spacing → colorsDatabase changes
Use Drizzle migrations:Testing the CLI locally
Build and link the CLI:Useful scripts
| Script | Description |
|---|---|
pnpm dev | Start all dev servers |
pnpm dev:lite | Start with lite Docker stack |
pnpm build | Build all packages |
pnpm lint | Run ESLint |
pnpm typecheck | Run TypeScript checks |
pnpm format | Check Prettier formatting |
pnpm format:fix | Fix formatting issues |
Getting help
- Check existing issues on GitHub
- Ask in the team Slack/Discord
- Review the codebase — most patterns are self-documenting
