📗 Table of Contents

• 📖 About the Project
  • 🗝️ Key Features
  • 🛠️ Built With
• 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 TV Show Finder

TV Show Finder is a tool to look for any TV show. It consumes two different APIs to give the user a seamless experience.

🗝️ Key Features

• Consumes the TVmaze API
• Consumes Microverse's Involvement API
• Allows the user to search by TV show's name
• Allows the user to like and comment on any episode
• Allows the user to see other users' likes and comments

🛠️ Built With

Client

• JavaScript

• HTML

• Bootstrap

• Webpack

(back to top)

🚀 Live Demo

• https://tv-shows-finder.dicodiaz.com.co/

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

• Install Node.js

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:dicodiaz/tv-shows-finder.git

Install

Install this project with:

  cd tv-shows-finder
  npm install

Usage

To run the project, execute the following commands:

  npm run serve

Run tests

To run tests, run the following command:

  npm run test

Deployment

There's a CD pipeline set up to track the develop branch.

Please open a PR from your feature branch to develop in order to contribute.

(back to top)

👥 Authors

👤 Dico Diaz Dussan

• GitHub: @dicodiaz
• LinkedIn: Dico Diaz Dussan
• Portfolio: portfolio.dicodiaz.com.co

👤 MUSTAFA ABBAS

• GitHub: @githubhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Increase unit test coverage

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• A huge thanks to Microverse for their constant support.

(back to top)

📝 License

This project is MIT licensed.

(back to top)