Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d-4-dibakar/task-manager-api
https://github.com/d-4-dibakar/task-manager-api
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/d-4-dibakar/task-manager-api
- Owner: D-4-DIBAKAR
- Created: 2024-08-14T16:10:14.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-08-15T16:56:35.000Z (3 months ago)
- Last Synced: 2024-08-15T19:07:06.797Z (3 months ago)
- Language: JavaScript
- Size: 431 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Task Manager API
This API allows users to create, manage, and delete tasks. It supports authentication and authorization, ensuring that only authorized users can access or modify tasks. The API is built using Node.js, Express.js, and MongoDB.
## Getting Started
### Prerequisites
Before you begin, ensure you have the following installed:
- Node.js v14+
- MongoDB v4+
- npm v6+
### Installation
Clone the repository:
```
git clone https://github.com/D-4-DIBAKAR/Task-Manager-API.git
cd Task-Manager-API
```
Install dependencies:
```
npm install
```
### Environment Variables
Create a .env file in the root directory and add the following environment variables:
```
MONGODB_URI=
JWT_SECRET=
PORT=5000
```
Replace `` and `` with your actual MongoDB URI and JWT secret key.
## Run Server
```
npm start
```
## API Endpoints
### Authentication
- Register a New User
`POST /api/register
`
- Login
`POST /api/login
`
### Task Management
- Create a New Task
`POST /api/tasks
`
- Get Tasks
`GET /api/tasks
`
**Query Parameters (Optional):**
1. status: Filter tasks by status (e.g., Pending, Completed)
2. priority: Filter tasks by priority (e.g., High, Medium, Low)
3. search: Search tasks by title or description
- Update a Task
`PUT /api/tasks/:id
`
- Delete a Task
`DELETE /api/tasks/:id
`
## Screenshots
