way-farer

Project description

WayFarer is a public bus transportation booking service.

UI Required features

Optional features

Technonlogies

Express JS - API development framework
Node - run time environment for JavaScript
Mocha and Chai - for testing
Eslint - code analysis tool for identifying problematic patterns found in JavaScript code
Babel JS - JavaScript compiler (ES6 to ES5)

Requirements and Installation steps

You need the following to be able to run the application

Node a runtime environment for JavaScript

Postman to test the Api endpoints

Visual studio code for editing and running the app

Clone the project

- git clone https://github.com/OkelloAndrewPeters/way-farer.git
- cd /way-farer
- npm install (to install required dependencies)
- npm run dev (to start the development server)

Testing

- npm run test

API endpoints

- POST /auth/signin - User Signin

- POST /auth/signup - User to create an account

- POST /trips - Create a trip

- GET /trips/<:trip-id> - Get a specific trip

- GET /trips - Get all trips.

- PATCH /trips/<:trip-id>/cancel - Cancel a trip

- GET /trips?origin=kigali -Filter trips based on origin.

- GET /trips?destination=kampala -Filter trips based on destination.

- POST /bookings - Book a seat on a trip

- GET /bookings - View all bookings

- DELETE /bookings/<:booking-id> - Delete a booking

UI Templates

https://OkelloAndrewPeters.github.io/way-farer/UI/

OkelloAndrewPeters/way-farer