Code Monkey home page Code Monkey logo

mydiary's Introduction

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

mydiary's People

Contributors

blackshady avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Forkers

ekibet

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.