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

https://github.com/errea/todo-reactapp

A todo List react App
https://github.com/errea/todo-reactapp

Last synced: 4 months ago
JSON representation

A todo List react App

Awesome Lists containing this project

README

        

![](https://img.shields.io/badge/Microverse-blueviolet)

# React to-do-app

This is a to-do list created using react features where I've consolidated my knowledge about components, props, state, and hooks, by following [this tutorial](https://ibaslogic.com/react-tutorial-for-beginners/)

[![View Code](https://img.shields.io/badge/View%20-Code-green)](https://github.com/errea/todo-reactApp)
[![Github Issues](https://github.com/errea/todo-reactApp/issues)
[![GitHub Pull Requests](https://github.com/errea/todo-reactApp/pull/1)

## What was built in this project:

- Todo list features (add, edit and remove to-do items).

- Components, hooks, props, states.

- Functional components.

- Styling.

- React Router.

## Image Preview
![Screenshot Main Page](./src/img/screen-shot.png)

## :star: [Live Demo](https://ibaslogic.github.io/react-todo-project/) :star:

## Getting Started

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

- On the project, GitHub page, navigate to the [main page of the repository](https://github.com/errea/todo-reactApp)

- Click on a button named `Code`

- Copy the project URL as displayed on HTTPS tab

- If you're running Windows Operating System, open your command prompt. On Linux, Open your terminal

- Change the current working directory to the location where you want the cloned directory to be made. Leave as it is if the current location is where you want the project to be.

- Type `git clone`, and then paste the URL you copied in Step 3.

`$ git clone https://github.com/errea/todo-reactApp.git` Press Enter key

- Your local copy will be created.

- Please note that you must have Git installed on your PC, this can be done [here](https://gist.github.com/derhuerst/1b15ff4652a867391f03)

- After you get the project aiming to the desired directory, you need now to install ruby globally and follow the steps below:

### Github Actions

To make sure the linters' checks using Github Actions work properly, you should follow the next steps:

1. On your recently forked repo, enable the GitHub Actions in the Actions tab.

2. Create the `feature/branch` and push.

3. Start working on your milestone as usual.

4. Open a PR from the `feature/branch` when your work is done.

## Project Structure

todo-App
└── node_modules
└── .github\workflows
└── linters.yml
└── src
└── /img
└── index.html
└── index.js
└── components
└── componentsStyles
└── style.css
└── .eslintrc.json
└── .gitignore
└── .hintrc
└──.stylelintrc.json
└── MIT.md
└── package-lock.json
└── package.json
└──README.md

### Usage

- Make sure you have npm and node installed in your terminal.

- I recommend the use of VS code as a code editor, but you can use whatever you want.

- Run in your terminal `npm start` OR `yarn start` to start React website.
## ✒️ Authors

👤 **Eri**

- Github: [@errea](https://github.com/errea)
- Twitter: [@Erreakay](https://github.com/errea)
- Linkedin: [Eri Okereafor](https://www.linkedin.com/in/eri-ngozi-okereafor/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/errea/todo-reactApp/issues).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- Microverse Activities

## 📝 License

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