Ridy Technical Documentation

1. Project Overview

Ridy is a full-stack taxi solution with three main user interfaces:

• Rider Frontend (Flutter)
• Driver Frontend (Flutter)
• Admin Panel (Angular)

The system follows a microservices architecture with separate APIs for each user type.

2. Directory Structure & Architecture

2.1 Core Structure

ridy/
├── apps/                    # Main applications
│   ├── rider-frontend/     # Rider mobile app (Flutter)
│   ├── driver-frontend/    # Driver mobile app (Flutter)
│   ├── admin-panel/        # Admin web interface (Angular)
│   ├── rider-api/          # Rider API service
│   ├── driver-api/         # Driver API service
│   └── admin-api/          # Admin API service
├── libs/                   # Shared libraries
│   ├── database/          # Database models and migrations
│   ├── flutter_common/    # Shared Flutter components
│   └── generic_map/       # Map functionality
└── docs/                  # Documentation

2.2 Technology Stack

• Frontend:
  • Mobile: Flutter (rider & driver apps)
  • Web: Angular (admin panel)
• Backend: Node.js with TypeScript
• Database: MySQL with TypeORM
• Architecture: Microservices with shared libraries

3. Developer Onboarding Guide

3.1 Initial Setup

1. Prerequisites:
   • Node.js (v14+)
   • Flutter SDK
   • MySQL
   • NPM/Yarn
2. Installation:

# Clone repository
git clone [repository-url]

# Install dependencies
npm install

# Setup database
npm run migration:run