Task Manager API is a RESTful API built with Node.js, Express, and MongoDB. It provides functionalities for user registration, login, and task management. This API is designed to be scalable leveraging the power of JavaScript and the robustness of MongoDB for data storage.
The Task Manager API is developed using the following primary tools and technologies:
- Node.js: A JavaScript runtime built on Chrome's V8 JavaScript engine, used for building scalable network applications. It provides the foundation for the API's server-side logic.
- Express.js: A minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications. Express.js is used to handle HTTP requests and responses, making it easier to build RESTful APIs.
- MongoDB: A source-available cross-platform document-oriented database program. Classified as a NoSQL database program, MongoDB uses JSON-like documents with optional schemas. MongoDB is used as the database for storing user and task data, providing a flexible and scalable solution for data storage. MongoDB Atlas: A fully-managed cloud database developed by the same people that build MongoDB. MongoDB Atlas handles all the complexity of deploying, managing, and healing deployments on the cloud service provider of your choice (AWS, Azure, and GCP). It's used in this project to provide a scalable and flexible document database as a service.
- Mongoose: An Object Data Modeling (ODM) library for MongoDB and Node.js. Mongoose provides a straightforward, schema-based solution to model your application data and includes built-in type casting, validation, query building, and business logic hooks.
- bcrypt: A library to help you hash passwords. It's used for securing user passwords before storing them in the database.
- jsonwebtoken: An implementation of JSON Web Tokens (JWT) for Node.js, used for creating and verifying tokens for authentication.
- dotenv: A zero-dependency module that loads environment variables from a .env file into process.env. It's used for managing environment variables, such as database connection strings and secret keys.
- cors: A package for providing a Connect/Express middleware that can be used to enable CORS with various options. It's used to handle Cross-Origin Resource Sharing, making it possible for the API to be consumed by web applications hosted on different domains
Before you begin, ensure you have the following installed on your system:
- Node.js (v14.x or higher): Node.js is a JavaScript runtime that allows you to run JavaScript on your server. You can download it from the official Node.js website. MongoDB (v4.x or higher): MongoDB is a NoSQL database that stores data in flexible, JSON-like documents. You can download it from the official MongoDB website.
- Clone the Repository: Use `git clone` to clone the repository.
- Navigate to Server Directory: Use `cd server` server to navigate to the project directory.
- Install Dependencies: Run `npm install` to install all necessary dependencies.
- Configure Environment Variables: Create a `config.env` file in the `src` directory and set the following environment variables:
- MONGO_URI: Your MongoDB database URL
- PORT: The port number on which your application will run
- TOKEN_SECRET_KEY: Your JSON Web Token (JWT) secret key
- Start the Server: Run `npm start` to start the server.
- Verify the Application is Running: Open your web browser and navigate to http://localhost:, replacing with the port number you specified in the `.env` file.
-
User Registration: Allows new users to register with a username and password.
-
User Authentication: Authenticates users and returns a token for subsequent requests.
-
Task Management: Provides endpoints for managing tasks, including creating, reading, updating, and deleting tasks.
-
Secure Access: Ensures that only authenticated users can access their tasks.
-
User Registration:
POST http://localhost:5000/api/auth/register -
User Login:
POST http://localhost:5000/api/auth/login -
Get All Tasks:
GET http://localhost:5000/api/tasks -
Create Task:
POST http://localhost:5000/api/tasks -
Get Task by ID:
GET http://localhost:5000/api/tasks/:taskId -
Update Task:
PUT http://localhost:/5000/api/tasks/:taskId -
Delete Task:
DELETE http://localhost:/5000/api/tasks/:taskId
The Task Manager API employs a robust authentication and authorization mechanism to ensure secure access to its resources. Authentication verifies the identity of users or applications accessing the API, while authorization determines what resources a user or application can access.
- Authentication Authentication is achieved through a combination of JSON Web Tokens (JWT). When a user logs in with their credentials, the server validates these credentials and, upon successful validation, issues a JWT. This token is then used to authenticate subsequent requests from the user. The JWT contains claims about the user, such as their username , which can be used for authorization checks.
- Authorization Each user is assigned one or more roles, and these roles determine what actions the user can perform within the API. For example, a user with a "Task Manager" role might be allowed to create, read, update, and delete tasks.
Data within the Task Manager API is managed using MongoDB, a NoSQL database that stores data in flexible, JSON-like documents. The API defines several data models, including User and Task, which are used to structure the data stored in MongoDB.
- User: Stores information about registered users, including their username, emails, hashed password. Task: Represents tasks created by users, including details such as the task title, description,createdBy and completion status.
email: sedra.mhanna313@gmail.com