https://github.com/mohamedhnoor/tvmaze-app

TvMaze-App is web application based on an external API. The website have a home page showing a list of items and a popup window with more data about an item that you can use to comment on it.
https://github.com/mohamedhnoor/tvmaze-app

css html javascript jest webpack

Last synced: 12 days ago
JSON representation

TvMaze-App is web application based on an external API. The website have a home page showing a list of items and a popup window with more data about an item that you can use to comment on it.

• Host: GitHub
• URL: https://github.com/mohamedhnoor/tvmaze-app
• Owner: MohamedHNoor
• License: mit
• Created: 2023-01-02T12:10:40.000Z (about 2 years ago)
• Default Branch: development
• Last Pushed: 2023-09-12T15:15:31.000Z (over 1 year ago)
• Last Synced: 2024-12-27T08:51:41.382Z (19 days ago)
• Topics: css, html, javascript, jest, webpack
• Language: JavaScript
• Homepage: https://mohamedhnoor.github.io/TvMaze-App/dist/
• Size: 675 KB
• Stars: 14
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 TvMaze-App

**TvMaze-App** is web application based on an external API. The website have a home page showing a list of items and a popup window with more data about an item that you can use to comment on it.

## 🛠 Built With 

- Html

- Css

- JavaScript

- Webpack

- jest

- TV Maze API

- Involvement API

### Tech Stack 

  Client

  


    
HTML

    
CSS

    
JavaScripts

    
Webpack

    
Jest

  


### Key Features 

- **[Project 1: The Home Page.]**

- **[Project 2: The Comments Popup]**

- **[Project 3: send and receive data from API.]**

(back to top)


## 🚀 Live Demo 

- [Live Demo Link](https://mohamedhnoor.github.io/TvMaze-App/dist/)

(back to top)


## 💻 Getting Started 

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

### Prerequisites

- Please install git in your computer.

- Also install a code editor.

- A web browser to view the output.

### Setup

- To clone my repository run this command https://github.com/MohamedHNoor/TvMaze-App.git

- Run npm install to install the dependencies.

- Open the dist/index.html file with a browser.

### Tests

- Please install Jest to your local environment.

- Run tests using `npm run test` command on your terminal.

(back to top)


## 👥 Authors 

👤 **Mohamed H Noor**

- GitHub: [@MohamedHNoor](https://github.com/MohamedHNoor)

- Twitter: [@MohamedHNoor](https://twitter.com/MohamedHNoor)

- LinkedIn: [@MohamedHNoor](https://www.linkedin.com/in/mohamedhnoor/)

👤 **Yash Solo**

- GitHub: [Yash](https://github.com/yash244466666)

- LinkedIn: [Yash Solo](https://www.linkedin.com/in/yash-solo)

- Twitter: [Yash Solo](https://twitter.com/yash_solo000)

(back to top)


## 🔭 Future Features 

- [ ] **Reservation Popup**

- [ ] **send and receive data from API.**

- [ ] **final touches.**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/MohamedHNoor/TvMaze-App/issues).

(back to top)


## ⭐️ Show your support 

If you like this project please give it an star. Thank you!

(back to top)


## 🙏 Acknowledgments 

We would like to thank Microverse for giving us this project to improve our skills.

- [TvMaze API](https://www.tvmaze.com/api).

(back to top)


## 📝 License 

This project is [MIT](MIT.md) licensed.

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)