TODO App

A simple todo app using Django, HTMX, Bootstrap and Alpine.js.

Preview

Features

• Create/update/delete projects
• Add tasks to your projects
• Update and delete tasks
• Prioritize tasks inside a project
• Choose deadline for your task
• Mark tasks as 'done'

Getting Started

Requirements

• Docker and Docker Compose
• Git

Installation

1. Clone the repository

   git clone https://github.com/dmitlenko/todo.git

2. Create .env file in the root directory. You can use .env.dist as a template.

   Note: Don't forget to generate a new SECRET_KEY for your .env file. You can use Djecrety to generate a new secret key.

3. Run the app using Docker Compose

   docker compose up -d

4. See the app running at localhost. This url is defined in your .env file.

Development

Requirements

• Python 3.12
• Poetry
• Docker and Docker Compose

Installation

1. Clone the repository

   git clone https://github.com/dmitlenko/todo.git

2. Create .env file in the root directory. You can use .env.dist as a template.

3. Install dependencies

   poetry install

4. Run the development database

   docker compose -f docker-compose.dev.yaml up -d

5. Run the development server

   poetry run python -m todo.manage runserver

Testing

To run tests, use the following command:

poetry run python -m todo.manage test

License

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

Acknowledgments

• Django
• HTMX
• Alpine.js
• Bootstrap