Git Product home page Git Product logo

todoapp-database's Introduction

TODO API

This is a simple TODO API that allows you to create, retrieve, update, and delete TODO items. You can use this API to manage your tasks efficiently.

Getting Started

To get started, follow the instructions below:

Prerequisites

Before you begin, make sure you have the following installed:

  • Node.js
  • MongoDB

Installation

  1. Clone the repository to your local machine:

    git clone https://github.com/your-username/your-repo.git
  2. Navigate to the project directory:

    cd your-repo
  3. Install the project dependencies:

    npm install
  4. Start the server:

    npm start

The server should now be running at http://localhost:4000.

API Endpoints

Create a TODO

  • Method: POST
  • Endpoint: /api/v1/createTodo
  • Request Body (JSON):
{
    "title": "Abir Pal",
    "description": "Hello Abir Pal"
}

Get All TODOs

  • Method: GET
  • Endpoint: /api/v1/getTodos

Get a Single TODO

  • Method: GET
  • Endpoint: /api/v1/getTodos/{todoId}

Replace {todoId} with the ID of the TODO item you want to retrieve.

Update a TODO

  • Method: PUT
  • Endpoint: /api/v1/updateTodo/{todoId}
  • Request Body (JSON):
{
    "title": "Lakshyadeep Gogoi",
    "description": "Welcome Back"
}

Replace {todoId} with the ID of the TODO item you want to update.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

  • Thanks to the open-source community for inspiration and support.

Feel free to customize this README as needed and replace placeholders like your-username and your-repo with your actual GitHub username and repository name.

todoapp-database's People

Contributors

lakshyadeepgogoi avatar

Stargazers

 avatar  avatar

Watchers

 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.