Skip to content
A public bus transportation booking API - Such that Users book tickets for their trips, can see all their bookings and have the right to cancel any booking they do not want to use again.
JavaScript
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app add search controller for users Jan 28, 2020
.babelrc initial commit Jan 28, 2020
.env_example initial commit Jan 28, 2020
.gitignore initial commit Jan 28, 2020
Procfile initial commit Jan 28, 2020
README.md made corrections to Readme Jan 28, 2020
env.js initial commit Jan 28, 2020
package.json add readMe Jan 28, 2020
server.js initial commit Jan 28, 2020
start.js initial commit Jan 28, 2020

README.md

Transport Booking Server

A public bus transportation booking server, developed the back-end API with NodeJs and ExpressJs

Table of Contents (Optional)

Usage

Features

Add to Base URL above

  • Use the following Endpoints

    POST /auth/signup Create User Account

    POST /auth/signin Login A User

    POST /trips Create a trip (Needs admin priviledges)

    GET /trips Get all trips

    POST /bookings Book a seat on a trip

    GET /bookings See all of your bookings

    DELETE /bookings/:bookingId Delete A Booking

    PATCH /trips/:tripId Cancel A Trip (Needs admin priviledges)

    GET /user/seed Seed users table with users with admin rights

    POST /admin/signup An admin can add new admin (Needs admin priviledges)

    PUT /user/:id/admin An admin can give a registered user admin right (Needs admin priviledges)

    PUT /bookings/:bookingId Update Booking Seat Number

    POST /buses Add a bus (Needs admin priviledges)

    GET /buses Get all buses (Needs admin priviledges)

    GET /trips/origin?origin="origin" Filter trips by origin

    GET /trips/destination?destination="destination" Filter trips by destination

  • A successful response will be

     { status: 'success', data: {} }

    or

     { status: 'success', data: [] }

    and an unsuccessful response will be

    { status: 'error', error: '​relevant-error-message' }

Contributing

I would love to hear from anyone that will like to contribute

Prerequisites

Settings

If you want set up locally you can follow these steps, you can also use postman(https://www.getpostman.com/downloads/) to test. Clone the repository, open terminal in root and do the following on terminal

$ npm install

After Setting up the database, create database tables running the command below, its advisable to run the command more than once and make sure your database is updated with the tables:

$ npm run create-dev-tables

Start server by running:

$ npm run start

Seed Database tables with users(with admin right) by running the command below, its advisable to run it more than once:

$ npm run seed-user-table

or use

GET /user/seed Endpoint

Test endpoints by running:

$ npm run test

License

None for now.

developed with 💕 by Blessing Krofegha

You can’t perform that action at this time.