avinashanand02/pedalstart

This project implements a RESTful API for managing tasks using Node.js, Express, and MongoDB with Mongoose.

Task Management REST API

This project implements a RESTful API for managing tasks using Node.js, Express, and MongoDB with Mongoose.

Features

• CRUD Operations: Allows creating, reading, updating, and deleting tasks.
• MongoDB Integration: Uses Mongoose to interact with a MongoDB database.
• Error Handling: Implements basic error handling for database operations.
• Middleware: Includes body-parser for parsing JSON and cors for handling Cross-Origin Resource Sharing.
• Routing: Defines routes for /api/tasks to manage tasks.

Prerequisites

Before running the application, make sure you have the following installed:

• Node.js
• MongoDB

Getting Started

1. Clone the repository:

   git clone https://github.com/AvinashAnand02/PedalStart.git
   cd PedalStart

2. Install dependencies:

   npm install

3. Set up MongoDB:

• Make sure MongoDB is running on localhost:27017 or update the connection string in app.js.

4. Start the server:

   npm start
   

The server will start running on http://localhost:3001.

API Endpoints

Get all tasks

• URL: /api/tasks
• Method: GET
• Response: Retrieves all tasks stored in the database.

Get a single task

• URL: /api/tasks/:id
• Method: GET
• Response: Retrieves a single task by its ID.

Create a task

• URL: /api/tasks
• Method: POST
• Request Body: JSON object with title, description, and dueDate fields.
• Response: Creates a new task and returns the created task object.

Update a task

• URL: /api/tasks/:id
• Method: PUT
• Request Body: JSON object with updated title, description, and dueDate fields.
• Response: Updates an existing task and returns the updated task object.

Delete a task

• URL: /api/tasks/:id
• Method: DELETE
• Response: Deletes a task by its ID and returns a success message.

Screenshots

License

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

Acknowledgments

Design inspired by Avinash Anand.

This Task Management Application was developed solely by me for the first round of the full-stack developer job role at PedalStart. Special thanks to PedalStart for providing the opportunity to showcase skills and abilities in this assignment.