- Clone our repo
Run
npm install
Start up the server
npm run start
We are using nodemon for reloading when something changes so feel free to make changes while the server is running in your local machine.
| Route | HTTP Verb | Description | Observations |
|---|---|---|---|
| /api/auth/login | POST | Returns token if correct username and password is provided | |
| /api/user/:userid | GET | Retrieve the information of a given user. | |
| /api/user/:userId | POST | Update a user | |
| /api/user | POST | Create or update a new user | |
| /api/user | GET | Get the list of all users | |
| /api/user | DELETE | Delete a user | Only administrators |
| /api/listing | GET | Get all listings | |
| /api/listing/:listingId | GET | Get a given listing by ID | |
| /api/listing | POST | Create a new listing | |
| /api/listing/:listingId | DELETE | Delete a given listing | |
| /api/request | GET | Get all the requests in the system | |
| /api/request/:requestId | GET | Get a given request info from a user to another | |
| /api/request | POST | Create a new rental request | |
| /api/request/:requestId | DELETE | Delete a given request. | Only administrators |
| /api/ratings/user | GET | Get all the user ratings | |
| /api/ratings/user | POST | Create or update a given rating | Only referred user or administrators |
| /api/ratings/user:userId | GET | Get the rating given to a user | |
| /api/user/ratings/:ratingId | DELETE | Delete a given rating | |
| /api/ratings/listing | GET | Get all the listing ratings | |
| /api/listing/ratings/ | POST | Creates a new listing rating | Parameters should be in query |
| /api/ratings/listing:listingId | GET | Get a given ratingId from a listing | |
| /api/ratings/listing:listingId | POST | Update a given listing rating | |
| /api/ratings/listing:listingId | DELETE | Delete a given listing rating |
- PATH="/Applications/Postgres.app/Contents/Versions/latest/bin:$PATH"
- heroku pg:psql --app share-goods