Codebase Onboarding Guide

The onboarding guide for the Node.js backend has been generated, covering the Docker-based setup and the internal routing architecture.

[Codebase Onboarding Guide]

Project Overview:

• Tech Stack: Node.js, Express, PostgreSQL, Docker, Jest.
• Architecture: Layered API Architecture (Controller-Service-Repository).
• Purpose: A RESTful backend service for managing real-time inventory tracking and order processing.

Quick Start:

1. Prerequisites: Node.js v18+, Docker Desktop, pnpm.
2. Install: pnpm install
3. Environment:
   • DATABASE_URL: Connection string (e.g., postgresql://user:pass@localhost:5432/db)
   • JWT_SECRET: String for auth token signing.
   • PORT: Default is 3000.
4. Run: docker-compose up -d then pnpm dev

Project Structure:

• src/controllers/: Handles incoming HTTP requests and input validation.
• src/services/: Contains core business logic and external integrations.
• src/models/: Sequelize/TypeORM definitions for database schema.
• src/routes/: Maps URI paths to specific controller functions.

Data Flow:
A request enters through src/app.ts, passes through global middleware (auth/logging), and is routed by src/routes/. The controller extracts data, passes it to the service layer for logic, which then interacts with the database via the model layer before returning a JSON response.

Common Workflows:

• Running Tests: Execute pnpm test to run Jest suites; use pnpm test:watch for TDD.
• Adding a Feature:
  1. Define the schema in src/models/.
  2. Create a service method in src/services/.
  3. Create a controller method to call the service.
  4. Register the new endpoint in src/routes/.

Deployment: Build the image using docker build -t api-service . and deploy to the staging cluster via the CI pipeline.

Next steps

• Verify the .env.example file matches the generated environment list.
• Add the "Adding a Feature" section to your internal developer wiki.
• Run the installation commands to ensure all prerequisites are captured correctly.