Skip to content

Latest commit

 

History

History
58 lines (48 loc) · 2.21 KB

README.md

File metadata and controls

58 lines (48 loc) · 2.21 KB
Raw

way-farer-api

WayFarer is a public bus transportation booking server. Build Status Coverage Status Maintainability

Description

Way-Farer is a public transport booking server that bridges the gap between commuters and transporter and ticketing.

This helps save time at ticketing stands and stress of long queues.

Prerequisites

Technologies

Features

  • User authentication signup and signin
  • Create Bus
  • Create Trip
  • View Trips
  • Cancel Trip
  • Create Booking
  • Get Bookings
  • Delete Bookings
  • Save seat number
  • View booking

Install Project

  • clone project on local machine
  • navigate into local repository by running cd way-farer-api
  • create db using createdb way-farer
  • create a .env file in root directory and fill it up using example in .env.example
  • run npm install
  • run npm start

Test

API test is written with mocha and supertest. Frontend tests is written with jest and enzyme.

  • clone project on local machine
  • navigate into local repository by running cd way-farer-api
  • create db using createdb way-farer
  • create a .env file in root directory and fill it up using example in .env.example
  • run npm install
  • run npm run test

How to contribute

  • The project is open for contribution. You can start by forking this project repo. If you have improvements you want to add, feel free to do so and create a PR against develop branch

Documentation

The API documentation for this project can be found here

License

MIT