https://github.com/krispyarena/todo-react
https://github.com/krispyarena/todo-react
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/krispyarena/todo-react
- Owner: krispyarena
- Created: 2024-07-26T17:05:11.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-07-30T16:50:07.000Z (10 months ago)
- Last Synced: 2025-01-21T10:51:17.810Z (5 months ago)
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# todo-react
Welcome to the `todo-react` repository! This is a simple yet powerful To-Do application built with React.js, designed to help you manage your tasks efficiently.
## Features
- **Add Tasks**: Easily add new tasks to your to-do list.
- **Edit Tasks**: Modify the details of existing tasks.
- **Delete Tasks**: Remove tasks that are no longer needed.
- **Mark as Complete**: Mark tasks as completed to keep track of your progress.
- **Filter Tasks**: Filter tasks based on their status (all, active, completed).
- **Responsive Design**: A mobile-friendly interface that works on all devices.
- **Local Storage**: Saves your tasks in the browser's local storage, so you don't lose them when you refresh the page.
## Getting Started
To get a local copy up and running, follow these steps.
### Prerequisites
Make sure you have the following installed on your machine:
- Node.js
- npm (Node Package Manager)
### Installation
1. Clone the repository:
```sh
git clone https://github.com/krispyarena/todo-react.git
```
2. Navigate to the project directory:
```sh
cd todo-react
```
3. Install the necessary packages:
```sh
npm install
```
### Running the Application
To start the application, run:
```sh
npm start
```
This will start the development server and you can view the application by navigating to `http://localhost:3000` in your web browser.
## Usage
- **Adding Tasks**: Type your task in the input field and press 'Enter' or click the 'Add Task' button.
- **Editing Tasks**: Click on a task to edit its details.
- **Deleting Tasks**: Click the 'Delete' button next to a task to remove it from the list.
- **Marking Tasks as Complete**: Click the checkbox next to a task to mark it as complete.
- **Filtering Tasks**: Use the filter buttons to view all tasks, only active tasks, or only completed tasks.
## Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Krishna Pandey - [[email protected]](mailto:[email protected])
Project Link: [https://github.com/krispyarena/todo-react](https://github.com/krispyarena/todo-react)
---