← Documentation Home

Development Guide

Development Environment Setup

Required Tools

{{REQUIRED_TOOLS}}

IDE Configuration

{{IDE_SETUP}}

Project Structure

{{PROJECT_STRUCTURE}}

Development Workflow

Branch Strategy

Commit Convention

<type>(<scope>): <subject>

<body>

<footer>

Types: feat, fix, docs, style, refactor, test, chore

Creating a Feature

# Create feature branch
git checkout -b feature/my-feature development

# Make changes and commit
git add .
git commit -m "feat(component): add new feature"

# Push and create MR
git push origin feature/my-feature

Testing

Running Tests

# Unit tests
vitest run

# Integration tests
{{INTEGRATION_TEST_COMMAND}}

# E2E tests
{{E2E_TEST_COMMAND}}

# Coverage report
{{COVERAGE_COMMAND}}

Writing Tests

{{TEST_GUIDELINES}}

Code Quality

Linting

eslint src --ext .ts

Formatting

prettier --write "**/*.{ts,tsx,js,jsx,json,md}"

Type Checking

{{TYPE_CHECK_COMMAND}}

Debugging

{{DEBUGGING_GUIDE}}

Database

Migrations

# Create migration
{{CREATE_MIGRATION_COMMAND}}

# Run migrations
{{RUN_MIGRATION_COMMAND}}

# Rollback
{{ROLLBACK_COMMAND}}

Seeding

{{SEED_COMMAND}}

API Development

Adding New Endpoints

{{API_DEVELOPMENT_GUIDE}}

OpenAPI Updates

# Validate OpenAPI spec
{{VALIDATE_OPENAPI_COMMAND}}

# Generate types
{{GENERATE_TYPES_COMMAND}}

Performance Profiling

{{PROFILING_GUIDE}}

Common Tasks

{{COMMON_TASKS}}