Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yuvenalmash/shyn-tv

Shyntv is a web applictaion using tvmaze API to get shows and display them. It also uses an interaction API to handle likes and comments.
https://github.com/yuvenalmash/shyn-tv

api-rest css javascript ui-design webpack

Last synced: about 4 hours ago
JSON representation

Shyntv is a web applictaion using tvmaze API to get shows and display them. It also uses an interaction API to handle likes and comments.

Awesome Lists containing this project

README

        


logo

API-based-webapp


# 📗 Table of Contents

- [� Table of Contents](#-table-of-contents)
- [📖 API-based-webapp ](#-api-based-webapp-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [🚀 Video Representation ](#-video-representation-)
- [💻 Getting Started ](#-getting-started-)
- [Visit And Open Files](#visit-and-open-files)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 API-based-webapp

**API-based-webapp** is a Show/Movies web application. It majorly displays different Shows and movies from the TVmaze API. The homepage shows a list of Shows/Movies you can like. The popup window shows more data on the Show/Movie selected and the user can comment on it too.

The project has two user interfaces:

- Homepage : The interface displays the following;
- A set of Shows/Movies all gotten from [TVmaze API](https://www.tvmaze.com/api)
- Likes interaction that displays number of likes for the Show/Movie. The user interface is derived from the[Involvement Api](https://www.notion.so/Involvement-API-869e60b5ad104603aa6db59e08150270)

- Popup window : The interface displays the following;
- Image of the selected Show/Movie.
- Details and plot summary of the Show/Movie selected.
- Comment Section. The user comments are displayed on the page. This was also gotten from the[Involvement Api](https://www.notion.so/Involvement-API-869e60b5ad104603aa6db59e08150270)

## 🛠 Built With

### Tech Stack

> This project was developed using html, css & javascript.

Client

API

### Key Features

> Below are the key features of the website:

- **Used TVmaze API for Show/Movies details and pictures**
- **Used Involvement API for likes and comments interaction**
- **Used webpack**
- **Add counter tests with jest**

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://yuvenalmash.github.io/API-based-webapp/dist/
)

(back to top)

## 🚀 Video Representation

- [Video Representation Link](https://drive.google.com/file/d/1OIBT3r2wCdjgWJ58tcUXIdAkCMSnopYg/view?usp=sharing)

(back to top)

## 💻 Getting Started

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

1. Clone this repository or download the Zip folder:

**``git clone https://github.com/yuvenalmash/API-based-webapp.git``**

2. Navigate to the location of the folder in your machine:

**``you@your-Pc-name:~$ cd ``**

### Visit And Open Files
1-Visit Repo
[Visit Repo](https://github.com/yuvenalmash/API-based-webapp)

2-Download Repo
[Download Repo](https://github.com/yuvenalmash/API-based-webapp/archive/refs/heads/main.zip)

(back to top)

## 👥 Authors

👤 **Yuvenal Njoroge**

- GitHub: [@githubhandle](https://github.com/yuvenalmash)
- Twitter: [@twitterhandle](https://twitter.com/_Juvenal_)
- LinkedIn: [LinkedIn](https://linkedin.com/in/yuvenal-njoroge)

👤 **Adeshina Adenuga**

- GitHub: [@githubhandle](https://github.com/nuga0909)
- Twitter: [@twitterhandle](https://twitter.com/nuga0909)
- LinkedIn: [LinkedIn](linkedin.com/in/adeshina-adenuga-282036171)

(back to top)

## 🔭 Future Features

> Implement full schedule and search tab functionalities.

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/yuvenalmash/API-based-webapp/issues).

(back to top)

## ⭐️ Show your support

If you like this project, Give a ⭐️.

(back to top)

## 🙏 Acknowledgments

- Project from [Microverse](https://www.microverse.org/?grsf=i6yi2m) html, css & Javascript module

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)