https://github.com/ayoubm490/netflox

NETFLOX is a web application that fetches TV Shows from an external API - TV Maze API. Users can like and comment on a TV Show. The likes and comments features are all handled by API. Built with Javascript.
https://github.com/ayoubm490/netflox

Last synced: about 8 hours ago
JSON representation

NETFLOX is a web application that fetches TV Shows from an external API - TV Maze API. Users can like and comment on a TV Show. The likes and comments features are all handled by API. Built with Javascript.

• Host: GitHub
• URL: https://github.com/ayoubm490/netflox
• Owner: AyoubM490
• Created: 2022-03-07T10:36:16.000Z (almost 3 years ago)
• Default Branch: dev
• Last Pushed: 2022-08-30T12:48:01.000Z (over 2 years ago)
• Last Synced: 2024-12-04T18:53:43.413Z (about 2 months ago)
• Language: JavaScript
• Homepage: https://ayoubms.github.io/NETFLOX/
• Size: 14.7 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![](https://img.shields.io/badge/Microverse-blueviolet)

# NETFLOX

> NETFLOX is a web application based on an external - here the TV Maze API. The API provides data about TV Shows. We then built the webapp around it. The webapp has 2 user interfaces (pages): The Homepage and the Comment modal. On the Homepage, a list of 6 TV Shows are present, each Show can be `liked` and commented on.

![screenshot](./src/assets/images/scrnsht.png)

## Built With

- HTML, CSS and JavaScript

- Webpack

- Jest

## Demo Presentation

For a demo presentation please visit this [link](https://drive.google.com/file/d/1MhHWGp7qNawExu1sP-Odo4PGh5FPm4X9/view?usp=sharing)

## Live Demo

Visit the live demo [here](https://ayoubms.github.io/NETFLOX/)

## Getting Started

### Setup

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

- Click the green `Code` button on the repo

- In your local PC, open your terminal in the folder you would like to clone the project.

- Clone the repo with the command: `git clone (copied link)`; like so: `git clone [email protected]:AyoubMS/api-capstone-project.git`

- On the terminal, navigate into the directory like so: `cd api-capstone-project`

- Checkout to branch name like so: `git checkout [branch name]`

- Run `npm i` to install the dependencies

- Run `npm start` to start the application

#### To run Test

- Run `npm run test`

### Usage

- Running `npm start` should start the server and open the `dist/index.html` file on the browser

- Click the `like` icon to like a TV Show

- Click the `Comment` to bring up the Comment modal

- The Comment modal would list the comments of the show if they exist

- You can type your name and comment to comment on the TV Show

## Author

👤 **Ayoub Chahir**

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

- [LinkedIn](https://www.linkedin.com/in/ayoub-chahir/)

👤 **Mahmoud Rizk**

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

- [LinkedIn](https://www.linkedin.com/in/mahmoud-rizk/)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- Hat tip to anyone whose code was used

- Inspiration

- etc