Development Setup

Set up your local development environment to contribute to Dits. This guide covers everything from cloning the repo to running tests.

Prerequisites

Initial Setup

1. Clone the Repository

# Clone your fork
git clone https://github.com/YOUR_USERNAME/dits.git
cd dits

# Add upstream remote
git remote add upstream https://github.com/byronwade/dits.git

# Fetch all branches
git fetch --all

2. Install Dependencies

# Install all dependencies
npm install

# This will install dependencies for:
# - Root workspace
# - All packages/*
# - All apps/*

3. Build the Project

# Build all packages
npm run build

# Or build specific package
npm run build -w @dits/core
npm run build -w @dits/cli

Project Structure

dits/
├── apps/
│   ├── web/          # Documentation website (Next.js)
│   └── cli/          # Command-line interface
├── packages/
│   ├── core/         # Core library
│   ├── storage/      # Storage backends
│   ├── network/      # Network protocols
│   └── shared/       # Shared utilities
├── tests/
│   ├── unit/         # Unit tests
│   ├── integration/  # Integration tests
│   └── e2e/          # End-to-end tests
└── docs/             # Additional documentation

Development Commands

VS Code Setup

Recommended Extensions

{
  "recommendations": [
    "dbaeumer.vscode-eslint",
    "esbenp.prettier-vscode",
    "bradlc.vscode-tailwindcss",
    "prisma.prisma",
    "ms-vscode.vscode-typescript-next"
  ]
}

Workspace Settings

{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
  "typescript.tsdk": "node_modules/typescript/lib"
}

Debugging

VS Code Launch Configuration

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Debug CLI",
      "program": "${workspaceFolder}/apps/cli/src/index.ts",
      "args": ["status"],
      "runtimeArgs": ["-r", "ts-node/register"],
      "console": "integratedTerminal"
    },
    {
      "type": "node",
      "request": "launch",
      "name": "Debug Tests",
      "program": "${workspaceFolder}/node_modules/vitest/vitest.mjs",
      "args": ["run", "--reporter=verbose"],
      "console": "integratedTerminal"
    }
  ]
}

Troubleshooting