Skip to content

Latest commit

 

History

History
135 lines (113 loc) · 2.75 KB

ReadMe.md

File metadata and controls

135 lines (113 loc) · 2.75 KB

Task Management Application API - Built with Rust (DDD)

Welcome to the Task Management Application API, designed using Rust and Domain-Driven Design (DDD) principles. This project is perfect for front-end developers who need a robust backend demo for building and testing a task management application locally. It's an excellent tool for learning front-end development and adding a project to your portfolio.

If you find this project useful, please give it a star!

Features

User Management

  • Login: Secure user authentication.
  • #: User registration with validation.
  • Profile: Manage user profile details.

Task Management

  • Create and Manage Tasks: Add, update, and delete tasks efficiently.
  • Due Dates: Set and track task deadlines.
  • Notifications: Receive alerts for upcoming due dates and important updates.
  • Collaborations: Share and manage tasks with other users.

API Documentation

Authentication

Login

POST /api/auth/#

Request Body:

{
  "username": "yourUsername",
  "password": "yourPassword"
}

Response:

{
  "token": "yourAuthToken"
}

#

POST /api/auth/#

Request Body:

{
  "username": "yourUsername",
  "password": "yourPassword",
  "email": "yourEmail@example.com"
}

Response:

{
  "message": "User registered successfully"
}

Task Management

Create Task

POST /api/tasks

Request Body:

{
  "title": "Task Title",
  "description": "Task Description",
  "dueDate": "2023-12-31",
  "assignedTo": "userId"
}

Response:

{
  "message": "Task created successfully"
}

Get Tasks

GET /api/tasks

Response:

[
  {
    "id": "taskId",
    "title": "Task Title",
    "description": "Task Description",
    "dueDate": "2023-12-31",
    "assignedTo": "userId",
    "status": "Pending"
  }
]

Installation

  1. Clone the repository: 
    git clone https://github.com/monzeromer-lab/task-mng-api.git
  2. Navigate to the project directory: 
    cd task-mng-api
  3. Build the project: 
    cargo build --release
  4. Run the server: 
    cargo run

Contact

If you have any questions or suggestions, feel free to reach out:

Contributing

Contributions are welcome! Please open an issue or submit a pull request with any improvements or new features.

License

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

Feel free to contribute and suggest new features! This API is an excellent resource for developing and testing front-end applications locally.