Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zahrabayatt authored Oct 18, 2024
1 parent aadbbdd commit c240b1c
Showing 1 changed file with 45 additions and 1 deletion.
46 changes: 45 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,45 @@
# to-do-app
# To Do App

This is a simple and interactive to-do app built with **Vite** and **React**. The app allows users to create tasks, organize them into categories, and manage their status. You can mark tasks as **done**, set them as **important**, and also edit or delete them. Categories can also be created, edited, or removed to further organize tasks.

Additionally, the app includes a **dark mode** and **light mode** toggle, and all user data (tasks, categories, and theme preference) is stored in **localStorage**, ensuring persistence between sessions.

## Features

- **Task Management**
- Add new tasks
- Mark tasks as done
- Mark tasks as important
- Edit or delete tasks
- Assign tasks to specific categories

- **Category Management**
- Create new categories
- Edit or delete existing categories

- **User Experience**
- Toggle between **dark** and **light** modes
- Responsive design
- Easy-to-use interface
- Organized view of tasks by category, importance, and completion status
- Persistent data storage using **localStorage** (tasks, categories, and selected theme)

## Tech Stack

- **React**: For building the user interface
- **Vite**: For bundling and running the app
- **Tailwind CSS**: For styling the app
- **Zustand**: For state management
- **React Router**: For handling navigation between different pages
- **localStorage**: For persisting tasks, categories, and theme data

## Deployment

The To-Do App is deployed and accessible at the following URL:

[To-Do App](https://zahrabayatt.github.io/to-do-app/)

## License

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

0 comments on commit c240b1c

Please sign in to comment.