SIMPLE_TODO_LIST

❯ A simple To-Do List application built with React and Tailwind CSS.

Built with the tools and technologies:

Table of Contents

• Overview
• Features
• Repository Structure
• Getting Started
• Contributing
• License
• Acknowledgments

---

Overview

SIMPLE_TODO_LIST is a minimalist to-do list application built with React and Tailwind CSS. It provides users with an intuitive interface to add, complete, and delete tasks, while persisting data across sessions using the browser's localStorage.

---

Features

• Add tasks and display them in a dynamic list.
• Toggle tasks between complete and incomplete states with immediate visual feedback.
• Remove tasks from the list seamlessly.
• Persist user data locally to maintain the to-do list between sessions.
• Styled with Tailwind CSS for a clean, responsive user interface.

---

Getting Started

Prerequisites

• Node: version 16.5 or higher (recommended)
• npm: Comes with Node.js

Installation

Build the project from source:

1. Clone the SIMPLE_TODO_LIST repository:

   ❯ git clone https://github.com/YourGitHubUsername/Simple_Todo_List

2. Navigate to the project directory:

   ❯ cd Simple_Todo_List

3. Install the required dependencies:

   ❯ npm install

Usage

To run the project in development mode, execute the following command:

❯ npm run dev

Then, open your browser and navigate to the URL provided in your terminal (typically http://localhost:3000).

---

Repository Structure

└── Simple_Todo_List/
    ├── README.md
    ├── package-lock.json
    ├── package.json
    ├── public
    │   └── assets
    │       ├── todo_icon.png
    │       ├── tick.png
    │       ├── not_tick.png
    │       └── delete.png
    ├── src
    │   ├── App.jsx
    │   ├── components
    │   │   ├── ToDo.jsx
    │   │   └── ToDoItems.jsx
    │   ├── index.css
    │   └── main.jsx
    └── vite.config.js

---

Contributing

Contributions are welcome! Here are some ways to contribute:

• Report Issues: If you find a bug or have a feature request, please open an issue.
• Submit Pull Requests: Fork the repository, make your changes, and open a pull request to contribute improvements.
• Join the Discussions: Share your feedback, ask questions, or discuss ideas in the discussions section.

Contributing Guidelines

1. Fork the Repository: Click the "Fork" button at the top-right of the repository page.
2. Clone Locally: Clone the forked repository to your local machine.

   git clone https://github.com/YourGitHubUsername/Simple_Todo_List

3. Create a New Branch: Always work on a new branch with a descriptive name.

   git checkout -b feature/your-feature-name

4. Make Your Changes: Implement your feature or bug fix.
5. Commit Your Changes: Write clear commit messages describing your changes.

   git commit -m "Describe your changes"

6. Push to GitHub: Push your branch to your fork.

   git push origin feature/your-feature-name

7. Submit a Pull Request: Open a pull request on the original repository.

Contributor Graph

---

License

Distributed under the MIT License. See LICENSE for more information.

---

Acknowledgments

• React
• Tailwind CSS
• Vite
• Inspired by modern minimalistic design principles.

Feel free to adjust repository links, version numbers, or any other details as needed for your project.