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

https://github.com/nitbravoa92/todolist-reactjs

This project consists of building a simple ToDoList App using the ReactJS library
https://github.com/nitbravoa92/todolist-reactjs

Last synced: 7 months ago
JSON representation

This project consists of building a simple ToDoList App using the ReactJS library

Awesome Lists containing this project

README

          





ToDoList App - ReactJS


# πŸ“— Table of Contents

- [πŸ“— Table of Contents](#-table-of-contents)
- [ToDoList App - ReactJS](#todolist-app---reactjs)
- [πŸ›  Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [πŸ’» Getting Started ](#-getting-started-)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Build](#build)
- [πŸ‘₯ Authors ](#-authors-)
- [πŸ”­ Future Features ](#-future-features-)
- [🀝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [πŸ™ Acknowledgments ](#-acknowledgments-)
- [πŸ“ License ](#-license-)

# ToDoList App - ReactJS

**ToDoList App** This project consists of building a ToDoList App using the ReactJS library, to show a list of Tasks and allow users to add, delete and update the status of each task.

## πŸ›  Built With

### Tech Stack

Client

### Key Features

- **Using the ReactJS library**
- **Using JSX syntax**
- **Use of semantic HTML**
- **SPA Approach**
- **Responsive design**

(back to top)

## πŸ’» Getting Started

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

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder-name
git clone git@github.com:NitBravoA92/todolist-reactjs.git
```

### Prerequisites

In order to install, modify and run this project, it is necessary to have the following applications installed:

- **Git:** to manage the project versions of source code. [You can Download Git here](https://git-scm.com/)

- **Nodejs and NPM:** to install and manage the project dependencies. [Nodejs and NPM installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)

- **A code editor** like Visual Studio Code (Recommended) or any other of your preference. It is necessary to open the project and add or modify the source code. [You can Download Visual Studio Code here](https://code.visualstudio.com/)

It is also important to have at least basic knowledge about ReactJS, JSX, HTML, CSS and Javascript languages so you will be able to understand and work with the code of the project.
- [Learn the basics of HTML](https://developer.mozilla.org/en-US/docs/Web/HTML)
- [Learn the basics of CSS](https://developer.mozilla.org/en-US/docs/Web/CSS)
- [JavaScript basics](https://developer.mozilla.org/en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics)
- [Javascript Arrays](https://developer.mozilla.org/es/docs/Web/JavaScript/Reference/Global_Objects/Array)
- [Javascript Objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
- [JavaScript modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)
- [ReactJS](https://react.dev/learn)
- [JSX](https://react.dev/learn/writing-markup-with-jsx)
- [Create React App](https://github.com/facebook/create-react-app)

### Install

Install this project by running the next command into your project folder:

```sh
npm install
```

All the packages and libraries necessary for the project to work will be installed in a folder called /node_module. After this installation, the project will be ready to use.

### Usage

In the project directory, you can run:

- `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\

You may also see any CSS and JS linters errors in the console running the following commands:

CSS Linter
```sh
npx stylelint "**/*.{css,scss}"
```

Javascript Linter
```sh
npx eslint "**/*.{js,jsx}"
```

### Build

- `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

## πŸ‘₯ Authors

πŸ‘€ **Nitcelis Bravo**

- GitHub: [Nitcelis Bravo](https://github.com/NitBravoA92)
- Twitter: [@softwareDevOne](https://twitter.com/softwareDevOne)
- LinkedIn: [Nitcelis Bravo AlcalΓ‘](https://www.linkedin.com/in/nitcelis-bravo-alcala-b65340158)

(back to top)

## πŸ”­ Future Features
- [x] **Update the UI of the ToDoList App**
- [ ] **Create the functionality to update a task title**
- [ ] **Add a button to remove all the completed tasks**
- [ ] **Add transitions and animations to the app**

(back to top)

## 🀝 Contributing

Contributions, issues, suggestions and feature requests are welcome!
Feel free to check the [issues page](../../issues/).

To do Contributions, please fork this repository, create a new branch and then create a Pull Request from your branch. You can find detailed description of this process in: [A Step by Step Guide to Making Your First GitHub Contribution by Brandon Morelli](https://codeburst.io/a-step-by-step-guide-to-making-your-first-github-contribution-5302260a2940)

(back to top)

## ⭐️ Show your support

If you liked this project, give me a "Star" (clicking the star button at the beginning of this page), share this repo with your developer community or make your contributions.

(back to top)

## πŸ™ Acknowledgments

I would like to thank my Microverse teammates for their support. They have supported me a lot in carrying out this project, giving me suggestions, good advice and solving my code doubts.

## πŸ“ License

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

(back to top)