Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 1.34 KB

README.md

File metadata and controls

45 lines (32 loc) · 1.34 KB
Raw

Project Name

North-Rift Shuttle Ticketing system

Description

This is the backend of a web-based bus ticketing system built with TypeScript ; The Project includes several controllers, models, and routes for managing bookings, paths, shuttles, and users. It also includes a winston logger for error handling.

Installation

To install the project, you need to have Node.js and npm installed on your machine. Then, you can clone the repository and install the dependencies:

git clone <repository-url>
cd <repository-name>
npm install

Usage

To start the server, run

npm start

Project structure

src/: This directory contains the source code of the project.
app.ts: The entry point of the application.
controllers/: This directory contains the controllers for the application.
lib/: This directory contains utility functions and constants.
models/: This directory contains the data models for the application.
routes/: This directory contains the routes for the application.
webApiHandler.ts: This file handles the web API.
logger.ts: This file handles logging.
package.json: This file contains the list of project dependencies and scripts.
tsconfig.json: This file contains the TypeScript compiler configuration.

Contact

If you have any questions or feedback, feel free to reach out to me at [x.johnkennedy.x@gmail.com]