> For the complete documentation index, see [llms.txt](https://junitiennguyen.gitbook.io/todo-list/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://junitiennguyen.gitbook.io/todo-list/master.md).

# README

[![](https://img.shields.io/github/contributors/juniHub/todo-localstorage-v2.svg?style=for-the-badge)](https://github.com/juniHub/todo-localstorage-v2/graphs/contributors) [![](https://img.shields.io/github/forks/juniHub/todo-localstorage-v2.svg?style=for-the-badge)](https://github.com/juniHub/todo-localstorage-v2/network/members) [![](https://img.shields.io/github/stars/juniHub/todo-localstorage-v2.svg?style=for-the-badge)](https://github.com/juniHub/todo-localstorage-v2/stargazers) [![](https://img.shields.io/github/issues/juniHub/todo-localstorage-v2.svg?style=for-the-badge)](https://github.com/juniHub/todo-localstorage-v2/issues) [![](https://img.shields.io/github/license/juniHub/todo-localstorage-v2.svg?style=for-the-badge)](https://github.com/juniHub/todo-localstorage-v2/blob/master/LICENSE.txt) [![Netlify Status](https://api.netlify.com/api/v1/badges/32d5dd9a-f342-402d-bda7-44f6f58865a6/deploy-status)](https://app.netlify.com/sites/juni-todo-list/deploys)

&#x20;[![Logo](/files/-Mahl-ptaETsodEvSoes)](<https://github.com/juniHub/todo-localstorage-v2&#xA;>)

### Juni Todo List

&#x20;project\_description\
&#x20;[**Explore the docs »**](<https://github.com/juniHub/todo-localstorage-v2&#xA;>)\
\
&#x20;[View Demo](https://juni-todo-list.netlify.app/) · [Report Bug](<https://github.com/juniHub/todo-localstorage-v2&#xA;/issues>) · [Request Feature](<https://github.com/juniHub/todo-localstorage-v2&#xA;/issues>)

## Table of Contents

1. &#x20;[About The Project](/todo-list/master.md#about-the-project)
   * [Built With](/todo-list/master.md#built-with)
2. &#x20;[Getting Started](/todo-list/master.md#getting-started)
   * [Prerequisites](/todo-list/master.md#prerequisites)
   * [Installation](/todo-list/master.md#installation)
3. [Usage](/todo-list/master.md#usage)
4. [Roadmap](/todo-list/master.md#roadmap)
5. [Contributing](/todo-list/master.md#contributing)
6. [License](/todo-list/master.md#license)
7. [Contact](/todo-list/master.md#contact)

## About The Project

![Juni-todo-screenshot](https://res.cloudinary.com/dafolrlpj/image/upload/v1627304397/gallery/xkoirg5oljvhhlsikgcx.png)

### Built With

* [ReactJS](https://reactjs.org/)
* [Material UI](https://material-ui.com/)
* [Local Storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)
* [Deployed on Netlify](https://www.netlify.com/)

## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

This is an example of how to list things you need to use the software and how to install them.

* npm

  ```bash
  npm install npm@latest -g
  ```

### Installation

1. Clone the repo

   ```bash
   git clone https://github.com/juniHub/todo-localstorage-v2.git
   ```
2. Install NPM packages

   ```bash
   npm install
   ```
3. Run the project locally on <http://localhost:3000>

   ```bash
   npm run start
   ```

## Usage

*For more examples, please refer to the* [*Documentation*](https://junitiennguyen.gitbook.io/todo-list)*. This will be continued for update and maintainance.*

## Roadmap

See the [open issues](https://github.com/juniHub/todo-localstorage-v2/issues) for a list of proposed features (and known issues).

## Contributing

Contributions are what make the open source community such an amazing place to be learned, inspired, and created. 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

Juni Nguyen - [helloJuni](https://hellojuninguyen.netlify.app/)

Project Link: <https://github.com/juniHub/todo-localstorage-v2>