Code Monkey home page Code Monkey logo

aishu1123 / task_management- Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 1.0 295 KB

The objective of this assignment is to create a web-based task management application using the MERN stack (MySQL, Express.js, React, Node.js) that allows users to add, update, delete, and view tasks.

Home Page: https://task-management-mauve-two.vercel.app/

JavaScript 97.52% HTML 1.97% CSS 0.50%
bcrypt-nodejs chakra-ui express html-css jwt-token mysql nodejs react seque tailwind-css

task_management-'s Introduction

Task Management Application Documentation

Overview

Welcome to the documentation for the Task Management Application backend API. This API allows users to manage tasks efficiently. It is built using React, Node.js, Express.js, and MySQL (MERN stack) as the backend stack.

Base URL

The base URL for all API endpoints is: https://localhost:3000/

Authentication

To access protected routes, users need to register and log in. Authentication is done via JWT tion.

Technical Stack

  • Frontend:

    • Tailwind
    • ChaKra-UI
    • React
    • Html-CSS
  • Backend:

    • Node.js
    • Express
    • MySQL
    • Sequelize

Installation

  1. Clone the repository:
    git clone <repository-url>
    
  2. Navigate to the project directory:
    cd Task_Management-
    
    
  3. Install dependencies:
    • Backend:
     cd Backend
     npm install
    
    • Frontend:
     cd Frontend
      npm install
    
  4. Start the backend server:
    cd Backend
    npm run server
    

5.Start the Frontend server:

cd Frontend
npm run dev

API Endpoints

Register

  • Method: POST
  • Endpoint: /user/register
  • Description: Allows users to register. Hashes the password on store.
  • Request Body:
    {
      "name": "Aishwarya",
      "email": "[email protected]",
      "password": "1234"
     }
    

Login

  • Method: POST
  • Endpoint: /user/login
  • Description: Allows users to login. Hashes the password on store.
  • Request Body:
    {
      "email": "[email protected]",
      "password": "1234"
    }
    

Logout

  • Method: GET
  • Endpoint: /user/logout
  • Description: User Logged out. token push in blacklist[]
  • Request Body:
    {
    "token":"saddfsfhgafcggggh"
    }
    

Get All Tasks of Logged in User

  • Method: GET
  • Endpoint: /task
  • Description: Return only logged in user's tasks list array .
  • Request Body:
    {
    "title": "Task1",
    "description": "Abcd"
    }
    

Get Task by ID

  • Method: GET

  • Endpoint: /task/:id

  • Description: Returns the details of a specific task identified by its ID.

  • Request Body:

    • Response: task Object

Add New Task

  • Method: POST
  • Endpoint: /task
  • Description: Allows user to add new task
  • Request Body:
    {
      "title": "Task Title",
    "description": "Task Content",
    }
    

Update Task by ID

  • Method: PUT
  • Endpoint: /task/:id
  • Description: Allows user to update the details of a specific task identified by its ID.
  • Request Body:
    • Response: Updated Array of task object

Delete Task by ID

  • Method: DELETE
  • Endpoint: /task/:id
  • Description: Allows user to delete the details of a specific task identified by its ID.
  • Request Body:
    • Response: Delete Task Object

Error Handling

The API handles errors gracefully and returns appropriate HTTP status codes and error messages.

task_management-'s People

Contributors

aishu1123 avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.