FlexDelivery24 API

A comprehensive delivery management platform built with NestJS, providing job creation, delivery matching, bidding, rewards, reviews, and comprehensive admin functionality.

Table of Contents

Features

🔐 Authentication & Authorization

📦 Jobs & Deliveries

🚚 Delivery Offers

💰 Rewards & Points

⭐ Reviews & Ratings

📄 KYC & Document Verification

👥 User Management

💰 Wallet Management

💳 Payments & Transactions

🏦 Withdrawal Management

💸 Tax & Fee Management

🗺️ Serviceable Areas

📊 Admin Dashboard

📧 Contact Management

🔢 Formula Management

📝 Admin Activity Logs

🔔 Notifications

Architecture

This application follows Clean Architecture principles with clear separation of concerns:

┌─────────────────────────────────────┐
│      Presentation Layer             │
│  (Controllers, Guards, Interceptors)│
└──────────────┬──────────────────────┘
               │
┌──────────────▼──────────────────────┐
│      Application Layer               │
│  (Use Cases, DTOs, Mappers)         │
└──────────────┬──────────────────────┘
               │
┌──────────────▼──────────────────────┐
│      Domain Layer                    │
│  (Entities, Interfaces, Services)    │
└──────────────┬──────────────────────┘
               │
┌──────────────▼──────────────────────┐
│      Infrastructure Layer            │
│  (Repositories, External Services)   │
└──────────────────────────────────────┘

Module Structure

Project Structure

src/
├── config/                 # Application configuration
├── database/              # Database migrations
│   └── migrations/
├── modules/
│   ├── shared/           # Shared business logic
│   │   ├── application/  # Use cases, DTOs, mappers
│   │   ├── domain/       # Domain entities, interfaces
│   │   ├── infrastructure/ # Repositories, services, external APIs
│   │   ├── common/       # Utilities, constants, decorators
│   │   ├── errors/       # Error handling
│   │   └── presentation/ # Guards, interceptors, filters
│   ├── web/              # Web controllers (includes admin)
│   │   └── controllers/
│   └── mobile/           # Mobile controllers (user-only)
│       └── controllers/
└── main.ts               # Application entry point

For detailed structure documentation, see:

Getting Started

Prerequisites

Installation

# Install dependencies
npm install

# Copy environment file
cp .env.example .env

# Configure environment variables
# Edit .env with your database credentials, API keys, etc.

Environment Variables

Required environment variables (see .env.example):

Database Setup

# Run migrations
npm run migration:run:batch

# Seed initial data (roles, permissions)
npm run seed

Running the Application

# Development
npm run start:dev

# Production
npm run build
npm run start:prod

The API will be available at http://localhost:32901

API Documentation

API documentation is available via Swagger UI when the application is running:

API Response Format

All API responses follow a standard format:

{
  success: boolean;
  message: string;
  data?: any;           // Present if data exists
  errors?: any;         // Present if errors exist
  statusCode: number;
  timestamp: string;
}

Paginated Responses

Paginated responses include metadata:

{
  success: boolean;
  message: string;
  data: {
    docs: any[];        // Array of results
    meta: {
      total: number;
      page: number;
      limit: number;
      totalPages: number;
      hasNextPage: boolean;
      hasPrevPage: boolean;
    }
  };
  statusCode: number;
  timestamp: string;
}

Authentication

Login Flow

  1. POST /api/v1/web/auth/login or /api/v1/mobile/auth/login

  2. OTP Verification (if phone not verified)

Token Usage

Include the access token in the Authorization header:

Authorization: Bearer <access_token>

Role-Based Access

Modules

Shared Module

Core business logic shared between web and mobile:

Web Module

Web-specific controllers:

Mobile Module

Mobile-specific controllers:

Database

Migrations

Database schema is managed through TypeORM migrations:

Key Tables

See Database README for details.

Development

Code Style

Adding New Features

  1. Create DTOs in src/modules/shared/application/dto/
  2. Create Use Case in src/modules/shared/application/use-cases/[feature]/
  3. Create/Update Repository if needed
  4. Create Controller in src/modules/web/controllers/ and/or src/modules/mobile/controllers/
  5. Register in appropriate module

Testing

# Unit tests
npm run test

# E2E tests
npm run test:e2e

# Test coverage
npm run test:cov

Scripts

# Development
npm run start:dev

# Build
npm run build

# Production
npm run start:prod

# Migrations
npm run migration:run
npm run migration:revert
npm run migration:generate -- -n MigrationName

# Format code
npm run format

# Lint
npm run lint

Key Conventions

Naming Conventions

Response Format

Error Handling

Admin Endpoints

Technology Stack

License

[Your License Here]

Support

For issues and questions, please contact the development team.