Task_Management

Welcome to Task Manager API, a simple API for managing tasks.

Sample Output

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Endpoints
  • Examples
• Contributing
• License

Getting Started

Prerequisites

• Node.js and npm installed
• MongoDB database

Installation

1. Clone the repository:

   git clone https://github.com/8309h/Taskify.git
   cd Backend

2. Install dependencies:

   npm install

3. Set up your environment variables by creating a .env file in the project root and adding the following:

   PORT=3000
   mongoUrl=your_mongodb_uri

4. Start the server:

   npm run server

Usage

Endpoints

• GET /api/tasks

  • Get all tasks.

• POST /api/tasks

  • Create a new task.
  • Request body:

    {
      "title": "Task Title 1",
      "description": "Task Description 1"
    }

• PUT /api/tasks/:id

  • Update a task.
  • Request body (any of the following):

    {
      "title": "New Title"
    }

• DELETE /api/tasks/:id

  • Delete a task.

• PATCH /api/tasks/:id/complete

  • Mark a task as completed.

Examples

Get all tasks

curl http://localhost:3000/api/tasks

Create a new task

curl -X POST -H "Content-Type: application/json" -d '{"title": "New Task", "description": "Task Description"}' http://localhost:3000/api/tasks

Update a task

curl -X PUT -H "Content-Type: application/json" -d '{"title": "Updated Title"}' http://localhost:3000/api/tasks/:id

Delete a task

curl -X DELETE http://localhost:3000/api/tasks/:id

Mark a task as completed

curl -X PUT http://localhost:3000/api/tasks/:id/complete

Contributing

Feel free to contribute to this project. Fork it, create a pull request, and your contributions will be considered.