MY-DIARY

This is an application that lets Users create, view and modify diary entries.

Table of Contents

• Technologies
• Features
• API Endpoints
• Getting Started
  • Installation
  • Testing
  • Development

Pivotal Tracker

Project is currently being built with the Project Management Tool, Pivotal Tracker. You can find the template at https://www.pivotaltracker.com/n/projects/2183415

API Deployment

API is deployed at https://my-diary-challenge.herokuapp.com

Technologies

• NodeJS - Runtime Environment
• ExpressJs - Web Application Framework
• npm - Dependency Manager

Supporting Packages

Linter(s)

• ESLint - Linter Tool

Compiler

• Babel - Compiler for ES6 Javascript

Test Tools

• Mocha - JavaScript Test Framework for API Tests
• Chai - TDD/BDD Assertion Library for Node

Features

Users

• View landing page
• Create account
• Login
• Create diary entries
• View diary entries
• View a single diary entries
• Modify diary entries
• Delete diary entries
• Add Notification to make a new entry

Getting Started

Installation

• git clone MY_DIARY
• Run npm install to install packages
• Run npm run build to build the project
• Run npm start to start the server
• Navigate to localhost:3000 in a browser to access the application

Testing

Prerequisites

• Postman - API Toolchain

Testing with Postman

• After installing as shown above
• Navigate to localhost:3000 in Postman to access the application

Testing with Coverage Data

• After installing as shown

• Run npm test

• It will lint code, run test and display coverage data as generated by nyc

Development

You can run npm run start:serve in development to use Babe-Node

Babe-Node helps to compile es6 codes to es5 before running the server.