Welcome to the Task Management API! T
his API allows users to create, read, update, and delete tasks. Users are able to categorize tasks, set deadlines, and mark tasks as complete or incomplete.
➢ User registration and login ➢ CRUD operations for tasks ➢ Task categorization and deadlines ➢ User-specific task management
https://tasks-api-axia.vercel.app
Here is a table summarizing the endpoints:
Endpoint | Description | Method |
---|---|---|
/api/user/register | Register users that want to create, list, update, and delete tasks. | POST |
/api/user/login | Login users that want to check and create more tasks. | POST |
/api/user/logout | Users are allowed to logout. | POST |
Endpoint | Description | Method |
---|---|---|
/api/task | Users are able to create tasks. | POST |
/api/tasks/:id | Users are able to update tasks. | PUT |
/api/tasks | Users are able to get all tasks. | GET |
/api/task/:id | Users are able to get a task by id. | GET |
/api/tasks/:id | Users are able to delete a task. | DELETE |
Endpoint | Description | Method |
---|---|---|
/api/tasks/:id | Users are able to update tasks. | PUT |
/api/tasks=?category=value&deadline=value | Users are able to get all tasks filtered by category and deadline | GET |
/api/tasks=?category=value | Users are able to get all tasks filtered by category | GET |
/api/tasks=?deadline=value | Users are able to get all tasks filtered by deadline | GET |
-
Fork this repository
-
Clone the repository:
git clone https://github.com/username/task-management-api.git
- Navigate to the project directory:
cd task-management-api
- Install dependencies:
npm install
-
Set up environment variables:
- Create a
.env
file in the root directory. - Add necessary environment variables (e.g., database connection strings).
- Create a
-
Start the server:
npm start
Execute the following command to run tests:
npm test
Contributions are welcome! Please create an issue or submit a pull request with your improvements.
This project is licensed under the MIT License.
For questions or support, please reach out to motuncoded.
Thank you for using the Task Management API! Happy tasking!