David-Verde/microverse-js-APITVMAZE

Streamy App

This is a TV show catalog application built using the TvMaze API.

Built With

• Languages:

  • HTML5 & CSS3
  • JavaScript

• Preprocessors:

  • Sass

• Technologies:

  • Webpack

• Conventions and Methodologies:

  • MVC pattern
  • BEM

Documentation Video

Click on this link to see the documentation video: Doc Video Link

Getting Started

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

Prerequisites

• Web Browser (e.g. Firefox, Chrome, Edge)
• NPM (Node Package Manager)

Setup

Download the code from this repository.

Install

1- Install the project dependencies using this command on the root project directory:

$ npm install

2- Then, run this command to build the application's code:

$ npm run build

Usage

Open the index.html file inside the dist/ folder in your Web Browser.

Testing

After installing all the project dependencies using the first command mentioned in the section install, run this command in the root project directory:

$ npm test

Authors

👤 Gabriel Santo

• GitHub: @gvgesanto2
• Twitter: @GabrielSanto997
• LinkedIn: Gabriel Santo

👤 David Verde Alvarez

• GitHub: @David-Verde
• Twitter: @DavidVerdeAlvarez
• LinkedIn: David Verde

🤝 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!

📝 License

This project is MIT licensed.