WayFarer is a public bus transportation booking service.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

The project is composed of two different parts:

• UI (User Interface)
• API Endpoints

• UI

  • Any Web Browser (We recommend using Google Chrome)
  • Text Editor (We recommend using VSCode)

• API Endpoints

  • Node JS
  • Postman (For testing api locally)
  • Postgres

• Simply Clone The project
• OR use git bash:
  1. First download git bash
  2. Install it
  3. Clone it by running git clone https://github.com/victorkarangwa4/WayFarer.git
  4. Find the project directory from where you are tunning the git bash.

1.For running the api

1. First download and install Node JS
2. Download and install Postman
3. Clone the project. WayFarer
4. Run npm install (sudo apt install for linux users) command for installing all project dependencies
5. Make sure you have downloaded and Installed postgres

1. Open command prompt
2. navigate to the directory of cloned project
3. Run the automated test by running npm run test command

• Just run index.html from the cloned project
• OR simply use ghpage to run WayFarer UI Template

• Server

  • Server side Framework: Node JS/Express
  • Linting Library: ESLint
  • Style Guide: Airbnb
  • Testing Framework: Mocha
  • Documentation Tools: Swagger
  • Database: Postgres
  • Hosting: Heroku )

• UI Templates

  • CSS
  • HTML
  • JS

1. Fork it
2. Create a branch (git checkout -b my_project)
3. Commit your changes (git commit -m "Added Stuff")
4. Push to the branch (git push origin my_project)
5. Create an Issue with a link to your branch

Victor KARANGWA

This project is licensed under the MIT License - see the LICENSE file for details

• Andela Kigali