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:
- First download git bash
- Install it
- Clone it by running
git clone https://github.com/victorkarangwa4/WayFarer.git
- Find the project directory from where you are tunning the git bash.
1.For running the api
- First download and install Node JS
- Download and install Postman
- Clone the project. WayFarer
- Run
npm install
(sudo apt install
for linux users) command for installing all project dependencies - Make sure you have downloaded and Installed postgres
- Open command prompt
- navigate to the directory of cloned project
- 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
-
UI Templates
- CSS
- HTML
- JS
- Fork it
- Create a branch (git checkout -b my_project)
- Commit your changes (git commit -m "Added Stuff")
- Push to the branch (git push origin my_project)
- Create an Issue with a link to your branch
This project is licensed under the MIT License - see the LICENSE file for details