📝 Task Management API

🔴 Live test

You can check this API live on this link : https://calm-dress-bear.cyclic.app/

👋 Introduction

This is a RESTful API for a task management application. It allows users to create, read, update, and delete tasks, and associate them with categories.

🚀 Getting Started

Prerequisites

• Node.js
• npm
• MongoDB
• Nodemon (For dev mode)

Installation

1. Clone this repository:

git clone https://github.com/barakgoren/ExpressJS-Final.git

2. Install dependencies:

npm install

⚙️ Configuration

• Create a new ".env" file and insert the fields:

  • JWT_SECRET_KEY - for configuring JWT.
  • USER_DB - The user name to your Atlas if you are using atlas
  • PASS_DB - The password to your Atlas if you are using atlas
  • ADMIN_PASS - This is the password you use to set yourself as an Admin.

• Modify the MongoDB URL to your Atlas URL or local URL on the app.js file.

  Example for running locally:

  mongoose.connect(`http://localhost:27017`)
    .then(() => {
        console.log('Connected to MongoDB');
    })
    .catch(err => {
        console.log(err);
    })

Running - Choose step 1 or 2:

1. Start the server with Nodemon on Development mode:

npm run dev

2. Start the server with Node.js:

npm start

📚 API Documentation

🚹 User Routes

Type	Route	Prerequisites	Description
	/users		Get all the users
	/users/me		Get your user details
	/users		Create new user
	/users/login		Log in to an existing user - Getting a token back
	/users/setAdmin/:id		Set a new admin. You can also use it to set yourself an admin by using the "adminPass" attribute on the config.js. Just send an "adminPass" on the body of the PATCH request.

👤 Create new User body:

{
    "name": "your name",
    "email": "[email protected]",
    "age": 30,
    "password": "your password"
}

👤 Login body:

{
    "email": "[email protected]",
    "password": "your password"
}

📝 Task Routes

Type	Route	Prerequisites	Description
	/tasks		Get all the tasks
	/tasks/myTasks		Get the tasks of the current user.
	/tasks		Create new task.
	/tasks/:id		Delete an existing task by its ID.
	/tasks/:id		Updating an existing task by its ID.

📝 Create new Task body:

{
    "title": "Task name",
    "category": "Category ID",
    "dueDate": "yyyy-MM-dd",
    "description": "Task description"
}

🏷️ Category Routes

Type	Route	Prerequisites	Description
	/categories		Get all the categories
	/categories/:id		Get the categories of the tasks by its ID
	/categories		Create a new category
	/categories/:id		Delete a category
	/categories/:id		Update a category

🏷️ Create new Category body:

{
    "name": "Category name",
    "description": "Category description"
}

🤝 Contributing

Contributions, issues and feature requests are welcome. Feel free to check issues page if you want to contribute.