Giter Site home page Giter Site logo

express-todolist's Introduction

TODO API - Node/Mongodb

Build Status Dependency Status devDependency Status codecov.io

Front end is changing day by day and we have to learn lot more stuffs. When we start learning a new framework or library, first thing is recommended to build a todo list which helps in doing all CRUD functions. But there is no solid backend/library available to make use of it to build a todo list.

This project is to help the front end engineers to build a todo app using this api without worring about the backend.

####Documentation

###Get all Todo:

url - http://apitodo.herokuapp.com/api/todos
method - get

Success Response:

{
  status: true,
  todo :[{
  		"_id":"56e7975dbf17876b095a0f21","todo":"From mock","__v":0,"created_by":"2016-03-15T05:02:21.041Z","completed":false
  }]
}

Error Response:

{status: false, error: "Message"}

###Post a todo

url - http://apitodo.herokuapp.com/api/todos/ method - post params: {todo: "Your todo"}

Note - By default it is marked as not completed

Success Response:

{
  status: true,
  todo:[{
  		"_id":"56e7975dbf17876b095a0f21","todo":"From mock","__v":0,"created_by":"2016-03-15T05:02:21.041Z","completed":false
  }]
}

Error Response:

{status: false, error: "Message"}

###Update status

url: http://apitodo.herokuapp.com/api/todos/_id

method - put

params: {completed: status }

status - boolean value

Success Response:

{status: true, message: "Status updated successfully"}

Error Response:
{status: false, error: "Status not updated"}

###Deleting a todo url: http://apitodo.herokuapp.com/api/todos/_id method: delete

Success Response:

{status: true, message: "Todo deleted successfully"}

Error Response:

{status: false, error: "Deleting todo is not successful"}

express-todolist's People

Watchers

James Cloos avatar Akther Hussain avatar

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.