Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lauragift21/ride-my-way
Ride-My-Way is a carpooling application that provides drivers with the ability to create ride offers and passengers to join available ride offers.
https://github.com/lauragift21/ride-my-way
airbnb api babel carpooling-application chai es6-javascript express mocha nodejs postgresql
Last synced: about 4 hours ago
JSON representation
Ride-My-Way is a carpooling application that provides drivers with the ability to create ride offers and passengers to join available ride offers.
- Host: GitHub
- URL: https://github.com/lauragift21/ride-my-way
- Owner: lauragift21
- License: mit
- Created: 2018-06-11T15:39:52.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2021-03-30T21:45:01.000Z (over 3 years ago)
- Last Synced: 2024-05-02T01:02:20.045Z (7 months ago)
- Topics: airbnb, api, babel, carpooling-application, chai, es6-javascript, express, mocha, nodejs, postgresql
- Language: JavaScript
- Homepage: https://ride-my-way-server.herokuapp.com/api/v1
- Size: 2.96 MB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ride-My-Way
[](https://travis-ci.org/lauragift21/Ride-My-Way) [](https://coveralls.io/github/lauragift21/Ride-My-Way?branch=develop&service=github) [](https://codeclimate.com/github/lauragift21/Ride-My-Way/maintainability) [](https://codeclimate.com/github/lauragift21/Ride-My-Way/test_coverage)
Ride-My-Way is a carpooling application that provides drivers with the ability to create ride offers and passengers to join available ride offers.
## Required Features
- Users can create an account and log in.
- 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 time
the ride leaves, where it is headed e.t.c
- Drivers can view the requests to the ride offer they created.
- Drivers can either accept or reject a ride request.
## Optional Features
- Users can only see and respond to ride offers from their friends on the application.
- Passengers get real time notifications when their request is accepted or rejected
## Technologies
- Nodejs
- Express
- Mocha, Chai, Babel, eslint
- Postgres
- JWT authentication
## API Endpoints
| Endpoint | Functionality |
| ------------------------------------------------ | ---------------------------------- |
| POST /auth/signup | Register a user |
| POST /auth/login | Login a user |
| GET /rides | Fetch all available rides |
| GET /rides/\ | Fetch the details of a single ride |
| POST /users/rides | Create a Ride offer |
| POST /rides/\/requests | Make a ride request |
| GET /users/rides/\/requests | Feth all ride requests |
| PUT /users/rides/\/requests/\ | Accept or Reject a ride request |
[Ride My Way API Documentation](https://ridemyway13.docs.apiary.io/#)
## Build Setup
```
clone repo and cd into directory
git clone https://github.com/lauragift21/Ride-My-Way.git
```
```
# install dependencies
yarn install # or npm install
#serve in development environment
yarn run dev
# build for production
yarn run build
```
## Testing
```
# Run test cases
yarn test
```
##
API Endpoint: https://ride-my-way-server.herokuapp.com/api/v1
UI Template: https://lauragift21.github.io/Ride-My-Way/UI/index.html
## AUTHOR
[EGWUENU GIFT](https://github.com/lauragift21)
## LICENSE
Ride My Way is [MIT licensed](https://github.com/lauragift21/Ride-My-Way/blob/develop/LICENSE)