/diary

Diary is an online journal where users can pen down their thoughts and feelings.

Primary LanguageHTML

Build Status Coverage Status Maintainability

Diary

Diary is an online journal where users can pen down their thoughts and feelings.

Links

  • UI Templates can be found here
  • This project is managed with Pivotal Tracker here

Features

Core Features

  • User can sign up.
  • User can sign in.
  • User can post an entry.
  • User can update his/her entry.
  • User can view a specific entry.
  • User can view all of his/her entries.
  • Admin can delete an entry.
  • Admin can view all posted entries.

Extra Features

  • User can reset password.
  • User can get daily notifications

Endpoint:

  1. Run the application , head to postman and test against the endpoints provided below.
   http://localhost:5000/api/v1/<endpoint>
Authentication
Method EndPoint Enable a user:
POST /auth/signup Register to the platform
POST /auth/signin Login to the platform
entries
Method EndPoint Enable a user:
POST /entries Create an entry
PATCH /entries/<entry_id> Update the entry
GET /entries/<entry_id> Get the entry details
DELETE /entries/<entry_id> delete the entry
Admin
Method EndPoint Enable a user:
POST /entries Create an entry
PATCH /entries Update entries
GET /entries Get entries
General
Method EndPoint Enable a user:
GET /entries/<entry_id> View a specific entry
GET /entries/ View a all available entries

Author