Task Management API

The Task Management API Project is a robust and scalable solution designed to streamline task organization and tracking for teams and individuals. This API enables users to create, manage, and monitor tasks efficiently, facilitating improved productivity and collaboration.

Features.
Technologies Used & Dependencies.
Project Structure.
Getting Started.
API Endpoints.
Available Base Url.
Validation.
Feedback and Contributing.
License.

Features

User Authentication: Secure user registration and login using encrypted passwords and JWT tokens.
Task Management: CRUD operations for managing tasks, including creation, retrieval, updating, and deletion.
Grouping Tasks: Enable users to add and manage tasks in their groups.
Validation: Input validation and data sanitization using Joi to ensure data integrity.
Security: Password hashing using Bcrypt.js to safeguard user credentials.

Technologies Used & Dependencies

Node.js: A server-side JavaScript runtime used to build fast and scalable network applications.
Express: A minimal and flexible Node.js web application framework that simplifies API development.
MongoDB: A NoSQL database used for efficient and flexible data storage.
Joi: A validation library for JavaScript that helps ensure the integrity of data.
Bcrypt.js: A library for hashing and salting passwords to enhance security.

For a complete list of dependencies, please refer to the package.json file.

Getting Started

To get started with the project, follow these steps:

Clone the Repository: Clone this repository to your local machine using the following command:

  git clone https://github.com/Hossam-H22/Task-Management__API.git

Install Dependencies: Navigate to the project directory and install the required dependencies using your preferred package manager:

  cd Task-Management__API
  npm install

Configure environment variables: Add variables for database connection, Cloudinary API keys, JWT secret, and token signature.
Run the Application: Start the development server to run the application locally:

  npm run dev

Access the Application: Open your web browser and visit http://localhost:5000 to use it as a base link.

Project Structure

The project structure follows a modular pattern to enhance maintainability and readability:

DB/
- Models/: Defines MongoDB schemas.
- connection.js: Connect to MongoDB.
src/
- middleware/: Middleware functions for authentication, error handling, etc.
- modules/: Defines API routes and connects them to controllers to perform their business logic.
- utils/: Utility functions for various tasks.
- app.js: Main Express application setup.

API Endpoints

Authentication
- POST /auth/login: Login user.
- POST /auth/signup: Register new user.
- PATCH /auth/forgetPassword: Send code to email to reset password.
- PATCH /auth/resetPassword: Reset forgetting password with new.
User
- GET /user: Retrieve details of a specific user.
- PATCH /user/updatePassword: Update password of the user.
Category
- GET /category: Retrieve a list of categories (and retrieve their tasks depending on parameters).
- GET /category/:id: Retrieve details of a specific category (and retrieve their tasks depending on parameters).
- POST /category: Create a new category.
- PUT /category/:id: Update category details.
Task
- GET /task: Retrieve a list of tasks.
- GET /task/:id: Retrieve details of a specific task.
- POST /task: Create a new task.
- PUT /task/:id: Update task details.

Detailed Postman API documentation can be found here.

Available Base Url

Validation

Input validation and data sanitization are performed using Joi, ensuring that data entering and leaving the API meet defined criteria, enhancing overall security and data integrity.

Feedback and Contributing

I'm excited to hear your feedback and discuss potential collaborations and if you'd like to contribute, please fork the repository, make your changes, and submit a pull request.

License

This project is licensed under the MIT license.

hossam-h22 / task-management__api Goto Github PK