Skip to content
/ todo Public

A simple todo list project using DRF (django rest framework)

AliMRBS/todo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

13 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“ Django DRF ToDo List API

A simple and functional ToDo List API built with Django REST Framework.
This project allows users to create, read, update, and delete their personal todo items.

πŸš€ Features

  • Full CRUD functionality for todo items
  • Both Function-Based Views and Class-Based Views are implemented
  • Usage of:
    • mixins
    • generics
    • viewsets
  • Multiple authentication methods:
    • Simple authentication
    • Token-based authentication
    • JWT (JSON Web Token) authentication
  • Integrated with Swagger for better and standardized API documentation

πŸ” Authentication

The project supports three authentication mechanisms:

  1. Basic Authentication β€” suitable for testing purposes
  2. Token Authentication β€” provides a token upon login
  3. JWT Authentication β€” recommended for production and modern frontend integrations

πŸ“š API Documentation

Swagger UI is included for interactive API exploration and easier frontend-backend collaboration.
You can access the Swagger docs by navigating to: http://127.0.0.1:8000/api/schema/swagger/

πŸ› οΈ Technologies Used

  • Python
  • Django
  • Django REST Framework
  • drf-yasg (for Swagger)
  • djangorestframework-simplejwt

βœ… How to Run

  1. Clone the repository:
    git clone https://github.com/AliMRBS/todo.git
    cd todo
    
  2. Create and activate a virtual environment
    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
    
  3. Install dependencies
    pip install -r requirements.txt
    
  4. Run migrations
    python manage.py migrate
    
  5. Start the development server
    python manage.py runserver
    
    

Author

Seyed Ali Mirabbasi

About

A simple todo list project using DRF (django rest framework)

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published