README.md

MyDiary app

Description

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

Setup

• Install Git locally
• Install NodeJS locally
• Clone the repo with git clone command
• run npm install to install all the dependencies locally

Scripts to use

• run npm run start:server to start server
• run npm run start:test to run tests
• run npm run start:coverage to run and view test coverages

API endpoints

• POST api/v2/auth/signup Create user account.

• POST api/v2/auth/signin Login a user.

  API endpoints with authentication requirements

• POST api/v2/entries Create an entry

• PATCH api/v2/entries/:entryId Modify an entry

• DELETE api/v2/entries/:entryId Users can delete an entry

• GET api/v2/entries Users can view their entries

• GET api/v2/entries/:entryId Users can view specific entry

Github pages

link: MyDiary web

HEROKU APP AND ITS DOCUMENTATION

link: API documentation with Swagger-UI