Skip to content

blackshady/MyDiary

Repository files navigation

Build Status Coverage Status Maintainability

MyDiary

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

Table of Contents

Pivotal Tracker

Check Here

Template

Template is hosted Here

API Deployment

API Endpoint is hosted Here

Technologies

  • NodeJS - JavaScript Runtime Environment
  • ExpressJs - A Minimal Web Application Framework
  • Mocha - JavaScript test framework
  • Chai - A BDD / TDD assertion library
  • Yarn - Dependency Manager

Style guide

Features

  • Users can create an account and log in
  • Users 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 set and get daily notifications that prompt them to add an entry to their diary

Getting Started

Prerequisites

Ensure you have NodeJS installed on your computer by entering node -v on your terminal. If you don't have NodeJS installed go to the NodeJS Website, and follow the download instructions

Installation

Clone the app

  • git clone https://github.com/blackshady/MyDiary.git

Install all the packages

  • yarn install

Run the server

  • yarn start

Server listens on port 9000

Testing

Run Test case

  • yarn test

Test Api

Working Routes

Endpoint Functionality
GET /entries Fetch all entries
GET /entries/:entryId  Fetch a single entry
POST /entries  Create an entry 
PUT /​entries​/:entryId​ Modify an entry 
POST /auth/signup Regetser a user
POST /auth/login Login a user
DELETE /entries/:entryId Delete a user Entry

Some Important Dependencies

About

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

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published