Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/gjuliao/todoapp_review

This a practice to review
https://github.com/gjuliao/todoapp_review

Last synced: about 1 month ago
JSON representation

This a practice to review

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)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 To Do List

**Todoapp_review** todoapp_review is a simple web application that displays a list of tasks and allows you to add new ones and remove completed ones from that list. This project also has jest tests to verify correct functionality of the code. This project served as a code review practice.

## 🛠 Built With

### Tech Stack

Functionality

Webpage

Styling

### Key Features

- **Pretty**
- **Simple to use**

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://vgonma.github.io/toDoList/dist/index.html)

(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:

NodeJs

### Setup

Clone this repository to your desired folder:

```cd my-folder
git clone [email protected]:gjuliao/todoapp_review.git
```
Install dependencies:
```
npm i -y
```

Build the webapp:
```
npm run build
```

You can use a live server for debuging using the command
```
npm run start
```

Tests can be run using the command line:

```
npm test
```
### Usage

To run the project open the html file in your web browser.

### Deployment

(back to top)

## 👥 Authors

👤 **Victor Gonzalez**

- GitHub: [@githubhandle](https://github.com/Vgonma)
- Twitter: [@twitterhandle](https://twitter.com/Victor_GonMa)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/victor-gonzalez-massimi/)

👤 **Giovanni Juliao**

- GitHub: [@githubhandle](https://github.com/gjuliao)
- Twitter: [@twitterhandle](https://twitter.com/GiovanniJuliao)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/giovanni-juliao-31770011/)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project feel free to give it a star.

(back to top)

## 🙏 Acknowledgments

We would like to thank Microverse for starting us in this project.

(back to top)

## ❓ FAQ

- **Can I contribute to the project?**

- Yes. By all means feel free to clone the repository and make your changes. (Always use a new branch)

- **Can I use this application freely?**

- You can use the application as long as you give credit where it is needed.

(back to top)

## 📝 License

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

(back to top)