Grocery-Helper-Api: A Description

Welcome to my Grocery-Helper-Api project. The purpose of this project is to create the API for client that want to request the data from grocery-helper-api to create a grocery-list. My Grocery-Helper-Api will allow client to create the new grocery list, show grocery-list that the user created, update grocery-list and delete the grocery-list. The require of this API is the client must have authentication to access the API. The client must sign-up with the unique email and password. Client will be able to change the password and signout after sign in.

Important links

Fontend-grocery-helper gitHub Repo

Heroku-deployed-site

grocery-helper-Client-Deployed-site

User Stories

• As a Grocery-helper-Api, I want to recieves the authentication method and response back.

  • if client successful request sign-up, I will response back 201 created.
  • if client successful request sign-up, I will response back 201 created and token.
  • if client successful request change-password, I will response 200 ok.
  • if client successful request sign-out, I will response 204 no content.
  • if client failed to request, I will response 400+ code.

• As a Grocery-helper-Api, I want to recieves the grocery-list method and response back.

  • if client successful request create-list, I will response 201 and store list into databse.
  • if client successful request show-list, I will response 200 and show list from database.
  • if client successful request update-list, I will response 200 ok and update list from database.
  • if client successful request delete-list, I will response 204 and delete from database.
  • if client have no authentication, I will response 401 unauthorized.
  • if client failed to create, update, delte list, I will response 400 bad request.

  Tecnologies used

  • Express
  • MongoDb
  • Mongoose
  • Handlerbar
  • nodemon

  Unsolved Problem

  • Api has a subdocument of items inside of grocery list Schema, items subdocument is array of item object that has a name and amount.
  • Api will be able to store the items with the picture that user can request the name amount and picture of item.

  Images

  ERD(entities Relation diagram)

  This ERD is the advance plan for my grocery roject. But the project has only one to many relation of user and List only. The one to many of list item will be create in the future.