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

https://github.com/brenoxav/to-do

A simple to-do list app.
https://github.com/brenoxav/to-do

css html javascript webpack

Last synced: 2 months ago
JSON representation

A simple to-do list app.

Awesome Lists containing this project

README

          

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

# To-do List

> A simple HTML list of To Do tasks

![screenshot](./screenshot.png)

A minimalist to-do list built with HTML, CSS, JS and Webpack.

## Built With

- HTML/CSS
- JavaScript
- Webpack

## Live Demo

[Click here](https://brenoxav.github.io/to-do) for a live demo of this project.

## Getting Started

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

### Prerequisites

- [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)

### Setup

1. Download or clone the repository's contents.
2. Go to the project's root directory.
```
cd to-do
```
3. Install all the dependencies:
```
npm install
```

### Install

You can either build a local production version of the project or open it directly on a server in development mode.

#### Build

1. To build and open a production version of the app run the command:
```
npm run build
```
2. Then open *dist/index.html* in you preferred browser.

#### Start Development Server

1. To open the app in development mode on *dev-server* run:
```
npm start
```
2. Then go to `http://localhost:8080/` in you preferred browser.

### Test

To execute the included tests with Jest, run:
```
npm test
```

## Authors

👨‍💻 **Breno Xavier**

- GitHub: [@brenoxav](https://github.com/brenoxav)
- Twitter: [@brenoxav](https://twitter.com/brenoxav)
- LinkedIn: [LinkedIn](https://linkedin.com/in/brenoxav)

👨‍💻 **Tiago Rahal**

- GitHub: [@tiagorahal](https://github.com/tiagorahal)
- Twitter: [@RahalAires](https://twitter.com/RahalAires)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/tiagorahal/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/brenoxav/to-do/issues/).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- Microverse