https://marketplacelambda.herokuapp.com/api/users/ [get] request to this url returns all user's username in the database
https://marketplacelambda.herokuapp.com/api/users/register [post] request to this url registers new user to the database, need { username:"randomusername", password:"randompassword" } (when making post request user_id, item_id is automatically assigned by the backend so do not put it in the request body)
https://marketplacelambda.herokuapp.com/api/users/login [post] request to this url logs in user, need { username:"randomusername", password:"randompassword" } should receive, user_id, username, password(hashed you learn about it in unit 4, security reason it encrypts the password)
https://marketplacelambda.herokuapp.com/api/shelf/ [get] request to this url returns all the items in the database, no need for log in
https://marketplacelambda.herokuapp.com/api/owner/:user_id/items
[post] request will add item under user who have (user_id).
{
"item_name":"required, doesn't accept item_name that already exist in database",
"item_price":"accepts only number bigger than 0, or will throw error",
"item_description":"not required"
}
for example when making request use template literal( backticks) to grab user_id from local storage
axiosWithAuth.post(https://marketplacelambda.herokuapp.com/api/owner/${localStorage.getItem('user_id')}/items
https://marketplacelambda.herokuapp.com/api/owner/deleteitem/:item_id [delete]request to this url with item_id will delete that item
https://marketplacelambda.herokuapp.com/api/owner/itemsforuser/user_id [get]request to this url will return only the items owned by user with user_id(will need a log in and later will need authentication)
https://marketplacelambda.herokuapp.com/api/owner/updateitem/:item_id [put] request to this url will update the item with item_id, item_price have to bigger than 0, no negative number is accepted i set validation so you can not change the item_id or user_id for the item
The following tutorial explains how to set up this project using PostgreSQL and Heroku.
- PostgreSQL, pgAdmin 4 and Heroku CLI installed in your local machine.
- A Heroku app with the Heroku PostgreSQL Addon added to it.
- Development and testing databases created with pgAdmin 4.
- Create a new repository using this template, and clone it to your local.
- Create a
.envfile and follow the instructions insideknexfile.js. - Fix the scripts inside
package.jsonto use your Heroku app.
- start: Runs the app in production.
- server: Runs the app in development.
- migrate: Migrates the local development database to the latest.
- rollback: Rolls back migrations in the local development database.
- seed: Truncates all tables in the local development database, feel free to add more seed files.
- test: Runs tests.
- deploy: Deploys the main branch to Heroku.
The following scripts NEED TO BE EDITED before using: replace YOUR_HEROKU_APP_NAME
- migrateh: Migrates the Heroku database to the latest.
- rollbackh: Rolls back migrations in the Heroku database.
- databaseh: Interact with the Heroku database from the command line using psql.
- seedh: Runs all seeds in the Heroku database.
-
Figure out the connection to the database and deployment before writing any code.
-
If you need to make changes to a migration file that has already been released to Heroku, follow this sequence:
- Roll back migrations in the Heroku database
- Deploy the latest code to Heroku
- Migrate the Heroku database to the latest
-
If your frontend devs are clear on the shape of the data they need, you can quickly build provisional endpoints that return mock data. They shouldn't have to wait for you to build the entire backend.
-
Keep your endpoints super lean: the bulk of the code belongs inside models and other middlewares.
-
Validating and sanitizing client data using a library is much less work than doing it manually.
-
Revealing crash messages to clients is a security risk, but during development it's helpful if your frontend devs are able to tell you what crashed.
-
PostgreSQL comes with fantastic built-in functions for hammering rows into whatever JSON shape.
-
If you want to edit a migration that has already been released but don't want to lose all the data, make a new migration instead. This is a more realistic flow for production apps: prod databases are never migrated down. We can migrate Heroku down freely only because there's no valuable data from customers in it. In this sense, Heroku is acting more like a staging environment than production.
-
If your fronted devs are interested in running the API locally, help them set up PostgreSQL & pgAdmin in their machines, and teach them how to run migrations in their local. This empowers them to (1) help you troubleshoot bugs, (2) obtain the latest code by simply doing
git pulland (3) work with their own data, without it being wiped every time you roll back the Heroku db. Collaboration is more fun and direct, and you don't need to deploy as often.
