Skip to content

The Todo API is a backend application built with Express.js and TypeScript for efficient task management. It provides essential features for creating, reading, updating, and deleting todo items, along with user authentication and structured error handling.

License

Notifications You must be signed in to change notification settings

aquie00tt/todo-api

Repository files navigation

Todo API

A simple and efficient Todo API built with Node.js, Express, and MongoDB. This API allows users to manage their todo items easily.

Features

  • User registration and authentication
  • Create, read, update, and delete (CRUD) operations for todos
  • Admin user management
  • JWT-based authentication
  • Error handling and logging
  • CORS support
  • Environment variable configuration

Technologies Used

  • Node.js
  • Express
  • MongoDB
  • Mongoose
  • JWT (JSON Web Token)
  • bcrypt for password hashing
  • Docker for containerization

Getting Started

Prerequisites

Make sure you have the following installed:

Installation

  1. Clone the repository:

    git clone https://github.com/aquie00tt/todo-api.git
    cd todo-api
  2. Install dependencies:

    npm install
  3. Create a .env.production file and configure your environment variables based on the .env.example provided.

  4. Start the application locally:

    npm start

Docker Setup

To run the API using Docker:

  1. Build the Docker image:
    docker build -t aquie00t/todo-api .
  2. Run the Docker container:
    docker run -p 5001:5001 aquie00t/todo-api

License

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

About

The Todo API is a backend application built with Express.js and TypeScript for efficient task management. It provides essential features for creating, reading, updating, and deleting todo items, along with user authentication and structured error handling.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages