Developer Guide

Welcome to the SALLY developer guide. This section covers everything you need to go from cloning the repository to shipping features on the SALLY fleet operations platform.

Prerequisites

Before you begin, make sure you have the following installed:

Optional (for full authentication):

• A Firebase project with Authentication enabled
• Google Maps API key (for distance calculations)

Reading Order

Work through these guides in order. You should be set up and running in about 15 minutes, and understand the codebase within an hour.

1. Environment Setup

Clone the repo, install dependencies, start infrastructure, and verify everything works. This is where you start.

2. Project Structure

Understand the monorepo layout — where code lives, how apps relate to each other, and where to put new code.

3. Architecture (Backend + Frontend)

Understand the design patterns before writing code:

• Backend Module Structure — NestJS domains, guards, decorators
• Database and Prisma — Schema, migrations, seeding
• App Router Guide — Next.js 15 routing and layouts
• Feature Modules — Frontend domain organization

4. Development Guides

Pick the guides relevant to your focus area:

Backend:

• Adding an Endpoint — Step-by-step tutorial
• Testing — Jest, Supertest, E2E tests

Frontend:

• UI Standards — Dark theme, Shadcn/ui, responsive design (mandatory reading)
• State Management — Zustand + React Query patterns

5. Common Tasks

Quick recipes for everyday operations: adding endpoints, pages, database tables, running migrations, and more.

Quick Links