API Documentation

Backend delpoyed at heroku

Getting started

To get the server running locally:

• Clone this repo and cd into carpal-be directory
• npm install to install all required dependencies
• npm run server to start the local server
• npm run test to start server using testing environment

Backend framework goes here

Express.js

Why did we choose this framework?

• Simplicity
• Minimal lines of code
• Flexible
• Scalable

Endpoints

User Routes

Method	Endpoint	Access Control	Description
POST	/auth/register	all users	Allows user to create an account
POST	/auth/login	all users	Allows user to authenticate and log into account
GET	/auth	owner	Allows for user retrieval from a token
PUT	/users/update	owner	Allows user to update their account
DELETE	/users/delete	owner	Allows user to delete their account

Location Routes

Method	Endpoint	Access Control	Description
GET	/locations	all users	Returns all locations entered by all users
GET	/locations/:id	owner	Returns a single location entered by user
POST	/locations	owner	Allows user to enter in a new location
PUT	/locations/:id	owner	Allows user to enter to update a location
DELETE	/locations/:id	owner	Delete a location

Favorite Locations Routes

Method	Endpoint	Access Control	Description
GET	/locations/favorites	owner	Returns all favorite locations for a user
GET	/locations/favorites/:id	owner	Return a specific favorite location
PUT	/locations/favorites/:id	owner	Update a user's certain favorite location
POST	/locations/favorites	owner	Add a favorite location for a user
DELETE	/locations/favorites/:id	owner	Delete a user's favorite location

Users Rides Routes

Method	Endpoint	Access Control	Description
GET	/users/rides	owner	Returns all rides for a user
GET	/users/rides/:id	owner	Returns aspecific ride for a user, including all requests
GET	/users/rides/riderStart/:id	owner	Returns ride information, including riders' locations
PUT	/users/rides	owner	Update a user's ride
POST	/users/rides	owner	Add a ride for a user
DELETE	/users/rides	owner	Delete a user's ride

Request Routes

Method	Endpoint	Access Control	Description
GET	/rides/requests/driver	owner	Returns all requests for a driver
GET	/rides/requests/rider	owner	Returns all requests for a rider
PUT	/rides/requests	owner	Update a user's certain request
POST	/rides/requests	owner	Add a requst for a user
DELETE	/rides/requests/:id	owner	Delete a user's request

Rides Routes

Method	Endpoint	Access Control	Description
GET	/rides	all users	Returns all rides
GET	/rides?start_location=%7B"long":<long>,"lat":<lat>%7D&end_location=%7B"long":<long>,"lat":<lat>	all users	Returns nearby rides
GET	/rides/id	all users	Returns a specific ride

Data Model

USERS

---

{
  "id": 10,
  "first_name": "panda",
  "last_name": "express",
  "email": "[email protected]",
  "is_driver": false,
  "phone_number": "3324343433",
  "created_at": "2020-03-17T00:21:48.597Z",
  "zip_code": 55343,
  "is_admin": false,
  "is_disabled": false,
  "bio": null,
  "profile_picture": null
}

LOCATIONS

---

{
  "id": 1,
  "lat": 39.385348651562,
  "long": -99.797763874469
}

RIDES

---

{
    "id": 1,
    "driver_id": 1,
    "rider_id": 2,
    "start_location_id": 1,
    "end_location_id": 2,
    "status": "pending"
}

REQUESTS

---

Driver

[
  {
    "id": 2,
    "rider_id": 2,
    "ride_id": 2,
    "rider_name": "daniel",
    "status": "confirmed"
  }
]

Rider

[
  {
    "id": 1,
    "driver_name": "daniel",
    "ride_id": 2,
    "status": "confirmed"
  }
]

Actions

Models

findBy(filter) -> find a single item using a filter (ie email, address, etc.)

findAll() -> Returns all from requested database

add(item) -> Add a record to requested database

update(id, item) -> Update a location using the id from req.params

delete(id) -> Delete a record using id from req.params

Auth

verifyToken() -> Verifies that user is authorized. Checks if they have a token

validateUserToken() -> Returns user information from token

validateLoginReqBody() -> Checks request body for email and password

validateRegisterReqBody() -> Checks request body for email, password, first_name and last_name

userExist() -> Searches for user by email and sets returned user object to req.data.user

Locations

locationCheck() -> Searches for location by lat and long and sets returned location object to req.location if exists

checkBody() -> Checks request body for lat and long

validateRiderId() -> Searches for user by id and sets returned user object to req.rider

validateRideId() -> Searches for ride by id and sets returned ride object to req.ride

getRideDetail() -> Searches for request by id and sets returned request object to req.ride_details

checkArrays() -> Checks request body for audioDislikes, audioLikes and hobbies

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables.

create a .env file that includes the following:

• DATABASE_URL - URL for postgres database
• DB - Connection for local Postgres DB instance
• DB_TEST - Connection for local Postgres DB instance
• USER - Reflect what is setup in pgAdmin in your local environment
• PASSWORD - Reflect what is setup in pgAdmin in your local environment
• NODE_ENV - set to "development" until ready for "production"
• GOOGLE_CLIENT_ID - a client ID for Google OAuth2
• GOOGLE_CLIENT_SECRET - a client secret for Google OAuth2
• TWILIO_SID - Twilio account SID
• TWILIO_TOKEN - Twilio account token

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

• Check first to see if your issue has already been reported.
• Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
• Create a live example of the problem.
• Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

• Ensure any install or build dependencies are removed before the end of the layer when doing a build.
• Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
• Ensure that your code conforms to our existing code conventions and test coverage.
• Include the relevant issue number, if applicable.
• You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Frontend Documentation for details on the fronend of our project.