Skip to content

Aisha-0118/React-todo-list

Repository files navigation

React Todo List 📝

GitHub release GitHub issues GitHub forks GitHub stars

Welcome to the React Todo List repository! This project showcases a simple yet effective todo list application built using React and TypeScript. It serves as a great example of how to manage state and share data between components using Context API and hooks like useState and useContext.

Table of Contents

Features

  • Create, read, update, and delete (CRUD) todo items.
  • Share data between components using React Context API.
  • Responsive design that works on both desktop and mobile devices.
  • Built with TypeScript for better type safety and development experience.
  • Simple and intuitive user interface.

Technologies Used

  • React: A JavaScript library for building user interfaces.
  • TypeScript: A typed superset of JavaScript that compiles to plain JavaScript.
  • Context API: A way to share values between components without having to explicitly pass props through every level of the tree.
  • Hooks: useState and useContext for managing state and context.

Getting Started

To get started with the React Todo List, you need to clone the repository and install the dependencies. Follow these steps:

  1. Clone the repository:

    git clone https://github.com/Aisha-0118/React-todo-list.git
  2. Navigate to the project directory:

    cd React-todo-list
  3. Install the dependencies:

    npm install
  4. Start the development server:

    npm start

Now, you can access the application in your browser at http://localhost:3000.

Usage

Once the application is running, you can:

  • Add new todo items by entering text in the input field and clicking the "Add" button.
  • Mark items as complete by clicking on them.
  • Delete items by clicking the "Delete" button next to each todo.

Folder Structure

Here's a brief overview of the folder structure in this project:

React-todo-list/
├── public/
│   ├── index.html
│   └── favicon.ico
├── src/
│   ├── components/
│   │   ├── TodoItem.tsx
│   │   └── TodoList.tsx
│   ├── context/
│   │   └── TodoContext.tsx
│   ├── hooks/
│   │   └── useTodo.ts
│   ├── App.tsx
│   ├── index.tsx
│   └── styles.css
├── package.json
└── tsconfig.json
  • public/: Contains static files.
  • src/: Contains all source code, including components, context, and hooks.
  • components/: Contains the React components for the todo list.
  • context/: Contains the context API logic for state management.
  • hooks/: Contains custom hooks for managing todo logic.

Contributing

We welcome contributions to improve the React Todo List. To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them.
  4. Push to your branch.
  5. Create a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Releases

To download and execute the latest release, visit Releases. Make sure to check the "Releases" section for updates and new features.

Conclusion

Thank you for checking out the React Todo List project! We hope you find it useful for your own projects or as a learning tool. Feel free to explore the code, make improvements, and share your feedback. Happy coding!