README.md

NodeNote

A shopping list web app

Built with:

• Node.js
• Express
• jQuery
• Bootstrap
• Firebase
• MariaDB

By @anttus & @mkotkav

Rest API documentation:

Lists:

• Get list by id:
  GET /api/lists/LIST_ID
• Get user by id:
  GET /api/lists?userId=USER_ID
• Get users in the list:
  GET /api/lists/users/shared?listId=LIST_ID
• Insert list:
  PUT /api/lists?userId=USER_ID&listName=LIST_§NAME
• Insert user:
  PUT /api/lists/users?email=EMAIL&listId=LIST_ID
• Update list name:
  PATCH /api/lists?listId=LIST_ID&newName=NEW_NAME
• Remove list:
  DELETE /api/lists/LIST_ID

Items:

• Get items by list id:
  GET /api/items?listId=LIST_ID
• Insert item:
  PUT /api/items?name=ITEM_NAME&list_id=LIST_ID
• Update item name:
  PATCH /ap/items?itemId=ITEM_ID&newName=NEW_NAME
• Update item status:
  PATCH /api/items/status?itemId=ITEM_ID&completed=1/0
• Remove item:
  DELETE /api/items?listId=LIST_ID&itemId=ITEM_ID

Users:

• Get all users:
  GET /api/users
• Insert user:
  PUT /api/users?userId=USER_ID&email=EMAIL
• Remove user:
  DELETE /api/users?userId=USER_ID