d-beloved / Ride-my-way

A carpooling application that provides drivers with the ability to create ride offers and passengers to join available ride offers

Ride-my-way

A carpooling application that provides drivers with the ability to create ride offers and passengers to join available ride offers

The App is hosted on heroku here .

The endpoints are hosted on heroku here .

Made With

UI

* HTML for writing the webpage
* CSS for styling
* Javascript to add some behaviour

Server

* Nodejs for server-side logic
* Babel for transpiling
* Express for api routes implementation
* Heroku for hosting services
* PostgreSql for the App database

Continuous Integration

* Travis CI & Codeclimate for test automation
* Coveralls for test coverage report

Test-Driven Development

* Mocha & Chai for api route testing

Installation.

• Install Nodejs
• Clone this repo git clone https://github.com/d-beloved/WEconnect.git
• Run npm install to install the required dependencies
• Run npm test to fireup the tests
• Navigate to http://localhost:3110/api/v1/

Features of the template

• Users can Signup and log in on the app.
• Drivers can add ride offers..
• Passengers can view all available ride offers.
• Passengers can see the details of a ride offer and request to join the ride. E.g What date the ride leaves, where it is headed e.t.c
• Passengers can make a request for an available ride
• Drivers can view the requests to the ride offer they created.
• Drivers can either accept or reject a ride request.

Available APIs

HTTP REQUEST VERB	API ENDPOINT/PATH	ACTION
GET	/api/v1/	Welcomes users to the application
POST	/api/v1/auth/signup	Registers a new user on the app
POST	/api/v1/auth/login	Logs in a registered user
POST	/api/v1/users/rides	Allows users to create ride offers
GET	/api/v1/rides	Gets all avalaible ride offers in the app
GET	/api/v1/rides/:rideId	Gets one ride offer in the app
POST	/api/v1/rides/:rideId/requests	Makes a request for a ride offer
GET	/api/v1/users/rides/:rideId/requests	Get all request for a ride offer
PUT	/api/v1/users/rides/:rideId/requests/:requestId	Accepts or rejects a ride offer

For more details on how to use this API, check the Documentation out here .

License and Copyright

© Ayodeji Moronkeji

Licensed under the MIT License.