sikatikenmogne/DRF-todo-list-api

Simple Web API for to-do list API

Todo List API

This project is a part of the roadmap.sh project.

Description

This is a Todo List API built with Django and Django REST Framework. It provides endpoints to manage todo items.

Installation

1. Clone the repository:

   git clone https://github.com/your-username/todoListAPI.git
   cd todoListAPI

2. Install dependencies using Poetry:

   pip install poetry
   poetry install

3. Run migrations:

   poetry run python manage.py migrate

4. Start the development server:

   poetry run python manage.py runserver

Usage

You can access the API at http://127.0.0.1:8000/. The available endpoints are:

• GET /todos/ - List all todo items
• POST /todos/ - Create a new todo item
• GET /todos/{id}/ - Retrieve a specific todo item
• PUT /todos/{id}/ - Update a specific todo item
• DELETE /todos/{id}/ - Delete a specific todo item

Features

• User registration to create a new user
• Login endpoint to authenticate the user and generate a token
• CRUD operations for managing the to-do list
• Implement user authentication to allow only authorized users to access the to-do list
• Implement error handling and security measures
• Use a database to store the user and to-do list data (you can use any database of your choice)
• Implement proper data validation
• Implement pagination and filtering for the to-do list

Pre-commit Hooks

This project uses pre-commit hooks to ensure code quality. The hooks are configured in the .pre-commit-config.yaml file. To install the hooks, run:

pre-commit install

To run the hooks manually, use:

pre-commit run --all-files