This is my first relatively large project that uses a relational database. Although it is still under development, I believe it is quite complete, and over time, I will make maintenance and improvements. I hope you like it! 😺
- Lucas Winicius
Up to this moment (May 2nd, 2023), this API is not yet finalized, so some routes may undergo modifications. Therefore, I ask that you always pay attention to this documentation. I hope you like it!
git clone https://github.com/Lucas-Winicius/ecommerce.gitcd ecommerceInstall dependencies:
npm installNow that everything is installed, let's configure the environment variables.
Create a file called .env at the root of the project, following the parameters of the .env.example file.
PORT=3000
DATABASE_URL="postgresql://username:pass@host/database"
JWT_SECRET="random string"To do this, it's very simple. Just execute the commands below. The first one will create the database migrations, and the second one will start your project on the port defined in the .env file.
npm run buildnpm run startFor development, I recommend the command below:
npm run start:devWith all the steps complete, we now need to understand a little about all the routes. Or, if you prefer to understand on your own, just read the files inside /src/routes.
Before we begin, it's important to remember that the routes indicated by * require prior login.
This route will create the user's login and automatically return the authentication cookie.
Parameters on body:
name- required parameter - Stringemail- required parameter - Stringpassword- required parameter - String
This route will return the logged-in user, which will be sent by the cookie.
Parameters on body:
none- Login information will be sent by cookie.
This route will return the login cookie and more information about the user in `$.data´.
Parameters on body:
email- required parameter - Stringpassword- required parameter - String
This route will delete the user's authentication cookie.
Parameters on body:
none- This route does not use parameters in the body.
This route will return all registered products.
Parameters on body:
none- This route does not use parameters in the body.
This route will return a product.
Parameters on body:
none- This route does not use parameters in the body.
This route will register a new product.
Parameters on body:
name- required parameter - Stringdescription- required parameter - Stringprice- required parameter - Numberpromotion- required parameter - FloatpromotionPrice- required parameter - Float
This route will delete the indicated product.
Parameters on body:
none- This route does not use parameters in the body.
This route will update the indicated product.
Parameters on body:
name- optional parameter - Stringdescription- optional parameter - Stringprice- optional parameter - Numberpromotion- optional parameter - FloatpromotionPrice- optional parameter - Float
Now that you know how to use the available routes, let's learn more about the available returns.
In general, all returns will have a pattern, whether in case of success or in case of error.
In case of error, the returned structure will be:
{
"success": false,
"status": 500,
"message": "There was an error that we couldn't find the reason for.",
"secondaryMessage": "It seems like there's a ghost in the system! We tried to find the error, but it mysteriously vanished. We're working on exorcising it and solving the issue, please try again later.",
"error": {}
}Always in case of error, it will return false.
Request status.
Error message.
A message with a pinch of humor.
Full error object.
In case of success, the returned structure will be.
{
"success": true,
"status": 200,
"message": "Congratulations, the operation was successfully completed!",
"secondaryMessage": "Success guaranteed, you are more efficient than a robotic vacuum cleaner! Congratulations on your achievement!",
"data": {}
}Always in case of error, it will return true.
Request status.
Success message.
A message with a pinch of humor.
data returned from successful request
Thank you for reading up to this point.
