Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/codewithmayank-py/todo-app

ToDoBuddy is a Django-based To-Do application that allows users to efficiently manage tasks with features like user authentication, CRUD operations, and integration of MySQL and MongoDB databases.
https://github.com/codewithmayank-py/todo-app

django django-application django-framework django-project django-rest-framework django-tutorial project-learning python

Last synced: 21 days ago
JSON representation

ToDoBuddy is a Django-based To-Do application that allows users to efficiently manage tasks with features like user authentication, CRUD operations, and integration of MySQL and MongoDB databases.

Awesome Lists containing this project

README

        

# TodoBuddy

TodoBuddy is a simple and intuitive Todo Application built with Django. This project was created as a learning exercise and will be continuously improved as I advance my skills.

## Table of Contents

- [📖 Introduction](#introduction)
- [✨ Features](#features)
- [⚙️ Installation](#installation)
- [🚀 Usage](#usage)
- [📸 Screenshots](#screenshots)
- [🛠 Technologies Used](#technologies-used)
- [🔮 Future Updates](#future-updates)
- [🤝 Contributing](#contributing)
- [📜 License](#license)
- [📬 Contact](#contact)

## Introduction

📖 TodoBuddy is designed to help you manage your tasks efficiently. Whether you need to keep track of your daily chores or manage a complex project, TodoBuddy has got you covered.

## Features

✨ **Features:**

- Add, edit, and delete tasks
- Mark tasks as complete or incomplete
- View task details
- User-friendly interface

## Installation

⚙️ **Installation:**

To get started with TodoBuddy, follow these steps:

1. **Clone the repository:**
```bash
git clone https://github.com/CodeWithMayank-Py/Todo-App.git
cd myapp
```

2. **Create a virtual environment:**
```bash
python3 -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```

3. **Install dependencies:**
```bash
pip install -r requirements.txt
```

4. **Apply migrations:**
```bash
python manage.py migrate
```

5. **Run the development server:**
```bash
python manage.py runserver
```

6. **Access the application:**
Open your browser and go to `http://127.0.0.1:8000/`

## Usage

🚀 **Usage:**

Once the server is running, you can start using TodoBuddy to manage your tasks. The main functionalities include:

- **Home:** The landing page of TodoBuddy, displaying the application name and a brief introduction.
- **Task List:** View all your tasks.
- **Task Detail:** View details of a specific task.
- **Task Edit:** Edit an existing task.
- **Task Delete:** Delete a task.

## Screenshots

📸 **Screenshots:**

### Home Page
![Home](screenshots/home.png)

### Task List Page
![Task List](screenshots/task_list.png)

### Task Detail Page
![Task Detail](screenshots/task_detail.png)

### Task Edit Page
![Task Edit](screenshots/task_edit.png)

### Task Delete Page
![Task Delete](screenshots/task_delete.png)

## Technologies Used

🛠 **Technologies Used:**

- **Django:** Web framework for building the application.
- **Python:** Programming language used for backend development.
- **HTML/CSS:** Markup and styling for the frontend.
- **JavaScript:** For interactive elements on the frontend.
- **SQLite:** Default database for development.

## Future Updates

🔮 **Future Updates:**

We have exciting plans for future updates to TodoBuddy, including:

- **User Authentication:** Secure login and registration functionality.
- **Sessions Management:** Persistent user sessions.
- **Enhanced UI/UX:** Improved user interface and experience.
- **Notifications:** Task reminders and notifications.
- **API Integration:** RESTful API for external integrations.

Stay tuned for these updates!

## Contributing

🤝 **Contributing:**

Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.

1. **Fork the repository**
2. **Create a new branch**
```bash
git checkout -b feature/your-feature-name
```
3. **Commit your changes**
```bash
git commit -m "Add your commit message"
```
4. **Push to the branch**
```bash
git push origin feature/your-feature-name
```
5. **Open a pull request**

## License

📜 **License:**

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Contact

📬 **Contact:**

If you have any questions or feedback, feel free to reach out:

- **Email:** [email protected]
- **GitHub:** [CodeWithMayank-Py](https://github.com/CodeWithMayank-Py)

---

Thank you for using TodoBuddy! Happy task managing! 🎉