eric2umeh / tv-shows

A JavaScript Project that displays a list of tv shows, and allows users to like, add a comment and view other comments. It is built using JavaScript (ES6 & asynchronous calls), Webpack and tested with Jest

📗 Table of Contents

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

📖 TV Show

You can use TV Show web app to see all your favorites TV shows information and schedules.

🛠 Built With

Tech Stack

Build With

• HTML
• CSS
• JavaScript
• WebPack

Key Features

• List main TV shows information and schedule
• You can like a TV show
• You can add comments to a TV show
• You can read comments from other users

(back to top)

🚀 Live Demo

• Live Demo

(back to top)

Project Presentation Video

• Project Presentation Video

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need: a properly working pc or laptop and a modern web browser.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/anthonymr/js-capstone.git

Install

Install this project with:

  cd my-folder
  git clone https://github.com/anthonymr/js-capstone.git
  npm install

Usage

To run the project, open src/index.html in your web browser.

Run tests

To run tests, run the following commands:

  cd my-folder
  npm test

Deployment

To deply, please run the following commands:

  cd my-folder
  npm run build

APIs

• TVMaze: If you want to use this API, please visit api.tvmaze.com web page.
• Microverse Involvement API: If you want to use this API, please visit Microverse Involvement API

(back to top)

👥 Authors

👤 Eric Umeohabike

• GitHub: Eric Umeohabike
• Twitter: Eric Umeohabike
• LinkedIn: Eric Umeohabike

👤 Anthony Martin

• GitHub: Anthony Martin
• LinkedIn: Anthony Martin
• Twitter: Anthony Martin

(back to top)

🔭 Future Features

• Add reservations functionality

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please, share it with your friends.

(back to top)

🙏 Acknowledgments

We would like to thank to tvmaze.com for provide us the API used in this project. And special thanks to Microvers team for provide us the API used to store likes and comments.

(back to top)

📝 License

This project is MIT licensed.

(back to top)