Skip to content

An online journal where you can pen down your thoughts and feelings

Notifications You must be signed in to change notification settings

oladimillion/MyDiary

Repository files navigation

MyDiary  Build Status   Coverage Status   Test Coverage   Maintainability

MyDiary is an online journal where you can pen down your thoughts and feelings

Running the app locally

  1. Clone the repository:
git clone https://github.com/oladimillion/MyDiary.git
  1. Navigate into the cloned repository folder

  2. Install dependencies:

$ npm install
  1. run npm run start to start the server

  2. visit http://localhost:8000

App is live

visit https://mydiary-ola.herokuapp.com

App's API documentation

visit http://localhost:8000/api-docs or docs

App's API endpoints

Functionality HTTP Method API endpoints
Login POST /api/v1/auth/login
Registration POST /api/v1/auth/signup
Update Profile PUT /api/v1/auth/update
Add entry POST /api/v1/entries
Update entry PUT /api/v1/entries/<entryId>
Entry List GET /api/v1/entries
Entry Detail GET /api/v1/entries/<entryId>
Delete entry DELETE /api/v1/entries/<entryId>
Add/update reminder POST /api/v1/reminders
Delete reminder DELETE /api/v1/reminders/<remindersId>

App's template on Github Pages

Templates URLs
Login Login
Registration Registration
Add and Modify Add and Modify
Entry List and Entry Content Entry List and Entry Content