Git Product home page Git Product logo

todolistapi's Introduction

RESTFul TodoList API

A TodoList implemented with NodeJS and MongoDb (using mongoose).

Getting Started

Installing softwares and setting environment

Please, check if you have already installed all the needed stack.

  • NodeJS;
  • MongoDb;
  • Postman (optional);
  • A good text editor (your choice);

Installing dependencies

Using npm:

npm install

Using yarn:

yarn

Running the API:

Using npm:

npm run start

Using yarn:

yarn start

Usage example

Listing all tasks

Example (using axios):

axios
  .get("/tasks")
  .then(response => {
    console.log(response, "Tasks");
  })
  .catch(error => {
    console.log(error, "Error");
  });

Creating a task

Example (using axios):

const task = {
  name: "Study NodeJS"
};

axios
  .post("/tasks", task)
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.log(error);
  });

Updating a task

Example (using axios):

const task = {
  name: "Study NodeJS",
  id: 45678
};

const { id } = task;

axios
  .put(`/tasks/${id}`, {
    ...task,
    name: "Commit stuff"
  })
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.log(error);
  });

Deleting a single task

Example (using axios):

const id = 54453;

axios
  .delete(`/tasks/${id}`)
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.log(error);
  });

Listing a single task

Example (using axios):

const id = 54453;

axios
  .get(`/tasks/${id}`)
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.log(error);
  });

Running the tests

Not implemented yet :)

todolistapi's People

Contributors

wesleyramalho avatar generalgmt avatar olatundeg avatar

Watchers

James Cloos 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.