DIARY API

An Api that allows users to create, read and modify their diary logs

Features

• Users can create diary entries.
• Users can read all diary entries in the database.
• Users can read a specific diary entry by ID from the database.
• Users can update diary entries.
• Users can delete diary entries.
• Users can create accout using just their gmail (Social authentication).

Root Endpoint

[To be provided when API is fully Ready]

API Documentation

API documentation:

[To be provided when API is fully Ready]

The purpose of this API is to allow users to create, read, and manage whatever is in their diary log. This helps users to keep their thought organized and make them apprehensible digitally.

Pivotal tracker was used for the management of this project. [https://www.pivotaltracker.com/projects/2590691]

Getting Started

Prerequisites

In order to install and run this project locally, you would need to have the following installed on your local machine.

• Node JS
• Postgresql
• Pg 4 Admin or any Postgresql GUI of your choice.

Installation

• Clone this repository

git clone [https://github.com/nkasi-e/My-Diary.git]

• Navigate to the project directory
• Run npm install or yarn to install the project dependencies
• create a .env file and copy the contents of the .env file into it and supply the values for each variable

cp dev.env .env

• Create a Postgresql database and connect to the database for optimum result.