Octa Travel Booking Platform

README Documentation

This documentation provides an overview of the Octa travel Booking Management System, its features, project structure, installation steps, API documentation, and more.

Table of Contents

• Overview
• Features
• Project Structure
• Installation & Setup
• Running the Application
• API Documentation
• Versioning & Dependencies
• Additional Notes

Overview

The Octa Travel Booking Management System is a robust backend service designed for managing travel bookings. Built using Node.js and Express.js, it serves various user roles including admins, customers, and drivers. This system is scalable, secure, and follows modern practices to handle high-volume operations.

Features

• User authentication and authorization for Admin, Customer, and Driver roles.
• Comprehensive booking management including creation, assignment, and tracking.
• Dynamic pricing, surge pricing, and fallback strategies for efficient ride allocation.
• Admin routes for managing ride types, vehicle types, policies, business settings, and more.
• Real-time driver location updates and ride completion tracking.
• Integration with external APIs (e.g., Twilio) for messaging and notifications.

Project Structure

Project Structure

.
├── controller
│   ├── adminController.js
│   ├── customerController.js
│   └── driverController.js
├── database
│   └── mysql.js
├── libs
│   ├── bcrypt.js
│   └── token.js
├── middleware
│   └── verifyToken.js
├── node_modules
├── properties
│   └── constants.js
├── public
│   └── index.html
├── routes
│   ├── adminRoutes.js
│   ├── customerRoutes.js
│   └── driverRoutes.js
├── utilities
│   ├── bookingUtilities.js
│   ├── customerUtilities.js
│   ├── driverUtilities.js
│   └── geoUtils.js
├── validators
│   ├── driverValidator.js
│   └── [other validator files...]
├── .env
├── .gitignore
├── index.js
└── package.json

Installation & Setup

1. Clone the repository to your local machine.
2. Navigate to the project directory in your terminal.
3. Run npm install to install all dependencies.
4. Create a .env file with the necessary environment variables.

Running the Application

Use the following commands for different environments:

• npm run dev - Runs the application in development mode with nodemon.
• npm start - Runs the application in production mode.

API Documentation

The backend exposes a RESTful API with the following main routes:

• Admin Routes: Handle authentication, bookings, policies, ride types, vehicle types, dynamic pricing, surge pricing, geo fencing rules, driver verifications, and more.
• Customer Routes: Manage customer registration, login, booking creation, booking views, fare calculation, and ride completion.
• Driver Routes: Facilitate driver registration, login, booking views, location updates, ride completion, and document verification.

Versioning & Dependencies

This project is currently versioned at 1.0.0 and requires Node.js version 14.0.0 or higher. Key dependencies include:

• Express.js for server-side routing.
• Body-parser for parsing request bodies.
• Cors for handling cross-origin requests.
• Helmet for securing HTTP headers.
• JWT for secure authentication.
• Swagger-UI-Express for API documentation.
• Other libraries: axios, bcrypt, dotenv, twilio, and more.

Additional Notes

This system is designed with scalability and security in mind. It supports both development and production environments and is structured to allow easy extensions and modifications as the project grows.