Bus Ticketing Platform

The Bus Ticketing Platform is a web application that allows users to manage bus tickets, perform transactions, and manage their wallets.

Table of Contents

• Prerequisites
• Installation
  • Local Setup
  • Docker Setup
• Usage
• API Documentation

Prerequisites

• Node.js (version 14 or higher)
• Yarn package manager
• Docker and Docker Compose (for Docker setup)

Installation

Local Setup

1. Clone the repository:

   git clone https://github.com/sogunshola/express-bus-ticketing-backed.git
   cd express-bus-ticketing-backed

2. Install dependencies:

   yarn install

3. Copy the .env.example file to .env.development.local:

   cp .env.example .env

4. Run migrations and seed the database:

   yarn migrate:run
   yarn seed:run

Docker Setup

1. Clone the repository:

   git clone https://github.com/sogunshola/express-bus-ticketing-backed.git
   cd express-bus-ticketing-backed

2. Build the Docker image:

   docker-compose build

3. Run migrations and seed the database:

   docker-compose run web yarn migrate
   docker-compose run web yarn seed

Usage

• To start the server locally:

  yarn dev

• To start the server using Docker:

  docker-compose up

• Access the application at http://localhost:3000

API Documentation

The Postman API documentation can be found in the API Documentation file.