olusoladavid / my-diary

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status Coverage Status Maintainability

my-diary

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

Required Features

  • Users can create an account and log in.
  • User can view all entries to their diary.
  • Users can view the contents of a diary entry.
  • Users can add or modify an entry.
  • Users can delete an entry

Additional Features

  • Users can set and get daily notifications that prompt them to add an entry to their diary

Tech Stack

API Endpoints

Endpoint Functionality
POST /auth/signup Register a user
POST /auth/login Login a user
GET /profile Fetch user profile
PUT /profile Update user profile
GET /entries Fetch all entries
GET /entries/<entryId> Fetch a single entry
POST /entries Create an entry
PUT /entries/<entryId> Modify an entry
DELETE /entries/<entryId> Delete an entry

Build Setup

# Clone repo and cd into directory
git clone https://github.com/olusoladavid/my-diary.git
# Install dependencies
npm install

# Serve in development environment
npm run dev

# Build for production
npm run build

Testing

# Run test cases
npm test

Links

Documentation: https://my-diary-api.herokuapp.com/api/docs

API Endpoint: https://my-diary-api.herokuapp.com/api/v1

Live Client: https://olusoladavid.github.io/my-diary-client

License

  • MIT

About

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

License:MIT License


Languages

Language:JavaScript 57.7%Language:HTML 27.9%Language:CSS 14.4%