Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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


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

Last synced: 11 days ago
JSON representation

Awesome Lists containing this project

README

        

React ToDo App

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 Todo App

React Todo is an application that is developed with ReactJs. It is used to add, edit and delete items/tasks into the Todo list.

## 🛠 Built With
- React

### Tech Stack
- [React](react.dev)
- [Create React App](http://create-react-app.dev/)

### Key Features

- Displays todo items.
- Add todo item
- Update todo item
- Delete todo item

(back to top)

## 🚀 Live Demo

Have a look at the [live demo ](https://react-todo-zed.netlify.app/) of the project.

(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:
- npm installed
- node installed

### Setup

Clone this repository to your desired folder:
```sh
cd my-folder
git clone [email protected]/ZewdieMc/react-todo-app.git
```
### Install

Install this project with:
```sh
cd react-todo-app/
npm install
```

### Usage

To run the project:
```sh
npm start
```

### Run tests

To run tests, run the following command:

```sh
npm test
```

To check for css errors run:
```sh
npx stylelint "**/*.{css,scss}"
```
To check for js errors run:
```sh
npx eslint .
```

### Deployment

Deployed using Github Pages.

(back to top)

## 👥 Authors

👤 Zewdie Habtie

- GitHub: [@ZewdieMc](https://github.com/ZewdieMc)
- Twitter: [@HabtieZewdie](https://twitter.com/HabtieZewdie)
- LinkedIn: [Zewdie Habtie](https://linkedin.com/in/zewdie-habtie-sisay-947153172)

(back to top)

## 🔭 Future Features

- Install React Router and Create components.

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/ZewdieMc/react-todo-app/issues).

(back to top)

## ⭐️ Show your support

If you like this project send your feedback to encourage me to do more.

(back to top)

## 🙏 Acknowledgments

I would like to thank Microverse for offering me this opportunity to learn, and practice our skills.

(back to top)

## ❓ FAQ

- Why React?
- React has broader community support, and it is a very popular library.
- React is flexible and can be used to build different types of applications.
- React is easy to learn and use.

(back to top)

## 📝 License

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

(back to top)