Project Name

One paragraph statement about the project.

Additional description about the project and its features.

Built With

• HTML & CSS
• JavaScript
• Webpack

Live Demo

Check out a live demo of this app here.

Getting Started

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

Prerequisites

• npm

Setup

1. Download or clone the repository's contents.
2. Go to the project's root directory.

cd <project-folder>

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.

Author

👨‍💻 Breno Xavier

• GitHub: @brenoxav
• Twitter: @brenoxav
• LinkedIn: LinkedIn

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc