WayFarer

Overview

WayFarer is a public bus transportation booking server.

Table Of Contents

• Getting Started
• Features
• Technologies
• Setup
• Testing And Coverage
• Links
• Author
• License
• Acknowledegments

Getting Started

The following instruction will get you a copy of this project for development and testing purposes.

...download repository from command line

git clone https://github.com/kola-1/WayFarer.git

Features

• User can sign up
• User/Admin can sign in
• Admin can create trips
• User/Admin can view all trips
• User/Admin can view trips by filtering
• User can book a trip
• User can view all his or her bookings
• Admin can view all bookings
• User can delete his or her booking
• Admin can cancel a trip
• Admin can add a bus

Technologies

These are some of the softwares this project is created with:

• Node.js - A JavaScript runtime for building back-end applications
• Express - A minimalist web framework for Node.js
• Mocha - A JavaScript testing framework which runs on NodeJS
• Chai - A BDD / TDD assertion library for NodeJS that can be paired with javascript testing frameworks
• Babel - A tool that is used to convert ECMAScript 2015+ code into a backwards compatible version of JavaScript
• Nodemon - A utility that monitors changes in the source code and automatically restarts the server
• Eslint - A linting utility for JavaScript

Setup

To run this project on your development environment, install it locally from your command line using npm.

...run the following command to install all dependencies

npm install

• remember to add the environment variables as required in the .env.config file

• before running the server in development mode first set NODE_ENV to development

...run the following command to start the application with nodemon

npm run start-dev

• you can access the server locally on port 7000 i.e localhost:7000

Testing And Coverage

To run test and to get test coverage use the following command:

• before running the test or test coverage first set NODE_ENV to test

...run the following command for testing

npm test

...run the following command for test coverage

npm run test-coverage

Links

• Documentation
• API URL

Author

• Kola Akindoju

License

• This project is licensed under the MIT License

Acknowledegments

• Andela developer Fajodutimi - API versioning