Skip to content

🚀 New Hire Onboarding Guide

Welcome to the team! Follow this checklist on Day 1 to get your development environment completely ready.


Prerequisites Checklist

Ensure the following tools are installed in your WSL2 (Ubuntu) environment: * [x] Go (1.22+) (go version) * [x] Python (3.11+) (python3 --version) * [x] Node.js (20+) & pnpm/npm (node -v) * [x] Docker & Docker Compose (docker compose version) * [x] Make (make --version)


Step-by-Step Installation

1. Repository Setup & Git Config

# Clone the repository
git clone [https://github.com/](https://github.com/)<your-org>/dues-pay-engine.git
cd dues-pay-engine

# Set local Git identity
git config user.name "Your Name"
git config user.email "your.email@company.com"

2. Environment Configuration

Copy the template environment file to create your active local configuration:

cp .env.example .env

Environment Defaults

The default .env comes pre-configured for local development with Postgres running on localhost:5432 and the Go API on localhost:8080.

3. Start Core Database & Telemetry

# Start Docker daemon (if not already active)
sudo service docker start

# Spin up Postgres, Vector & VictoriaLogs
make up

4. Run Services Locally

Open separate terminal tabs for active development: * Terminal 1 (Go Backend): make run-api * Terminal 2 (React Frontend): make run-web * Terminal 3 (Python Worker): make run-worker * Terminal 4 (Documentation Hub): make docs-serve