kolynzb/todo-list-dj

This is a todo-list built in django

TODO list API

• This is an Application Programming Interface for a todo-list built in django and django rest framework with python.

Table Of Contents

• Project Folder Structure
• Django Apps
• How to Run API Locally

Folder Structure

C:.
├───todolist
├───docs
├───.vscode
├───api

Django Apps

• todolist
  • App containing django project settings and project configurations.
• api
  • App containing all todo-list api logic.

How to Run Project

• 👉🏿Click Me👈🏿 to get project installation instructions.

Python Version

• python 3.11.0
• Check the runtime.txt file

Features

• API Documentation with Swagger
• CRUD Functionality
• linting with Black
• Documentation with MKDOCS

Important URLs

After Installation and starting the server, visit the following URLs

1. Visit the browsable API at http://localhost:8000/api/v1/

2. Access the Django admin at http://localhost:8000/admin

3. Visit reDoc documentation http://localhost:8000/

4. Visit Swagger documentation http://localhost:8000/doc

5. • mkdocs serve - Start the live-reloading docs server.

Concept Diagrams

• Link to ERD Diagram

Postman collection

• Click me to see postman collection
• Simply import this file into your postman to see the API documentation and usage information.

Before Contribution

• Understand Git Flow
• Use Semantic Commit Messages

©todo-api