An open API service indexing awesome lists of open source software.

https://github.com/lily4178993/react-todo-app

"react-todo-app " is a tool that helps to organize a day
https://github.com/lily4178993/react-todo-app

archived-repository learning-project react redux

Last synced: 9 months ago
JSON representation

"react-todo-app " is a tool that helps to organize a day

Awesome Lists containing this project

README

          

# Table of Contents πŸ“—

- [About the Project πŸ“–](#about-project)
- [Built With](#built-with) πŸ› 
- [Tech Stack πŸ—œοΈ](#tech-stack)
- [Key Features 🏷️](#key-features)
- [Getting Started πŸ’»](#getting-started)
- [Setup βš™οΈ](#setup)
- [Prerequisites 🧱](#prerequisites)
- [Install πŸ—οΈ](#install)
- [Usage πŸ“‚](#usage)
- [Run tests πŸ§ͺ](#run-tests)
- [Author πŸ‘€](#author)
- [Future Features πŸ”­](#future-features)
- [Contributing 🀝](#contributing)
- [Show your support 🌟](#support)
- [Acknowledgements πŸ™](#acknowledgements)
- [License πŸ“](#license)



# React Todos πŸ“–

**React Todos** is a tool that helps to organize your day. It simply lists the things that you need to do and allows you to mark them as complete.


## Built With πŸ› 

### Tech Stack πŸ—œοΈ

Client



  • HTML5 markup to build raw structure of this web page




  • CSS3 custom properties


  • React Js




  • Linters for coding convention and coding formating



### Key Features 🏷️

- **Adding a new item**
- **Removing a selected item**
- **Marking a selected item as complete**

(back to top)





(back to top)



## Getting Started πŸ’»

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

### Prerequisites 🧱

In order to run this project you need:

- A Github account
- Node JS
- An IDE e.g [Visual studio code](https://code.visualstudio.com/).
- [A terminal](https://code.visualstudio.com/docs/terminal/basics).



### Setup βš™οΈ

Clone this repository to your desired folder:

```sh
git clone https://github.com/lily4178993/react-todo-app.git
```
- Navigate to the folder
```
cd react-todo-app
code .
```
- Checkout the branch
```
git checkout dev
```


### Install πŸ—οΈ

Install all dependencies:

```sh
npm install
```


### Usage πŸ“‚

To run the project, open your terminal and tap the following line.
```sh
npm start
```




### Run tests πŸ§ͺ

How should it be tested?
To run tests, run the following command:

- CSS linter errors run:

```sh
npx stylelint "**/*.{css,scss}" --fix
```

- JavaScript linter errors run:

```sh
npx eslint "**/*.{js,jsx}" --fix
```



(back to top)



## πŸ‘€ Author

**Nelly Telli**
- GitHub: [@lily4178993](https://github.com/lily4178993/)
- LinkedIn: [Nelly T.](https://www.linkedin.com/in/nelly-t-330414266/)

(back to top)



## Future Features πŸ”­

- **Add About and Contact Pages**
- **Add editing functionalities to Todos list items**

(back to top)



## Contributing 🀝

If you have suggestions πŸ“, ideas πŸ€”, or bug reports πŸ›, please feel free to open an [issue](https://github.com/lily4178993/react-todo-app/issues) on GitHub.
Remember, every contribution, no matter how big or small, makes a difference.

(back to top)



## Show your support 🌟

Thank you for taking the time to explore my GitHub project! Your support means a lot to me. If you find my project valuable and would like to contribute, here are a few ways you can support me:

- Star the project ⭐️
- Fork the project 🍴 🎣
- Share with others πŸ—ΊοΈ

(back to top)



## Acknowledgments πŸ™

I would like to express my sincere gratitude to [Microverse](https://github.com/microverseinc), the dedicated reviewers, and my [partner](https://github.com/SanaTameem).

I would also like to thank Icons8 for all the images and icons I used in this project.

(back to top)



## License πŸ“

This project is [MIT](./LICENSE) licensed.

(back to top)