Project Documentation: ToDo App

This documentation provides an overview of the ToDo app, a simple task management application developed using Django, Python's web framework. The app allows users to create, update, and delete tasks, as well as mark tasks as completed. It includes user authentication, allowing each user to manage their own tasks securely.

Table of Contents

1. Introduction
2. Features
3. Installation
4. Usage
5. Contributing
6. License

Introduction

This is one of my first projects in Django - a straightforward and minimalistic ToDo app! This app empowers users to track and manage their tasks efficiently, offering a clean interface that keeps distractions at bay. Stay organized and boost productivity with ease! 📝✨

Note: This is a beginner-friendly project and may not include all advanced features. It is meant for educational purposes and to provide a foundation for learning Django.

Features

• User Authentication: Users can sign up and log in to their personalized accounts, ensuring privacy and security for their tasks.
• Task Creation: Users can add new tasks with titles, descriptions, and completion status.
• Task List: The app displays a list of all tasks for the logged-in user, allowing easy access and management.
• Task Detail View: Users can view individual task details, including the title, description and completion status.
• Task Update: Users can edit task details, such as title, description, and completion status.
• Task Deletion: Users can delete tasks they no longer need.
• Task Search: The app includes a search feature, allowing users to find specific tasks quickly.

Installation

1. Ensure you have Python 3.x installed on your system.
2. Clone this repository to your local machine using git clone.
3. Navigate to the project directory using the terminal or command prompt.

Create a virtual environment (optional, but recommended):

python -m venv myenv

Activate the virtual environment:

• Windows:

myenv\Scripts\activate

• Linux / macOS:

source myenv/bin/activate

Install the required dependencies:

pip install -r requirements.txt

Note: The requirements.txt file includes all the necessary dependencies for the project. Make sure to have them installed in your virtual environment.

Important: Generate Your Own Secret Key

For security reasons, we have used environment variables to store sensitive information. One such variable is DJANGO_SECRET_KEY, which is crucial for Django's security.

To generate your own secret key, open a Python shell and run the following code:

import secrets

new_secret_key = secrets.token_hex(32)
print(new_secret_key)

Copy the generated key and set it in this format (SECRET_KEY = 'YOUR_SECRET_KEY'). Remember to keep your secret key private and avoid sharing it publicly.

Usage

1. Before running the application, create and apply the initial database migrations:

python manage.py makemigrations
python manage.py migrate

2. Create a superuser to access the Django admin panel (if needed):

python manage.py createsuperuser

3. Run the development server:

python manage.py runserver

4. Open your web browser and navigate to http://127.0.0.1:8000/ to access the ToDo app.

Contributing

We welcome contributions to the ToDo app! If you have any suggestions, bug fixes, or new features to propose, please follow these steps:

1. Fork the repository on GitHub.
2. Create a new branch for your feature or bug fix.
3. Implement your changes and tests, if applicable.
4. Commit your changes and push them to your fork.
5. Create a pull request to the main repository's main branch.

License

The ToDo app is open-source software released under the MIT License. You are free to use, modify, and distribute the code for personal and commercial purposes.