Skip to main content

Local Development Setup

Get your ApiTraffic development environment running locally.

Prerequisites

  • Node.js (v18+ recommended)
  • npm or yarn
  • Git
  • Docker (optional, for containerized development)

Installation

  1. Clone the repository:
  1. Install dependencies:

Development Options

Run all services locally with npm for maximum development speed:

Option 2: Docker Development

Run all services in Docker with volume mounts for live reloading:

Environment Configuration

Create your local environment file:
.env.local

Available Scripts

  • npm run dev - Start all services in development mode
  • npm run local - Start all services with local configuration
  • npm run build - Build all applications
  • npm run test - Run tests
  • npm run lint - Lint the codebase
  • npm run format - Format code using Prettier

Project Structure

Making Changes

  1. Create a new branch for your feature
  2. Make your changes
  3. Run tests: npm test
  4. Run linting: npm run lint
  5. Submit a pull request

Debugging

For VS Code debugging, use the provided launch configurations in .vscode/launch.json.