Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/iturres/tvmaze-shows-website

🎥 TVMaze is a website where you can see top shows related info, like them, and add comments. | Microverse's Module 2 - Group Capstone Project. Check it out! 👇
https://github.com/iturres/tvmaze-shows-website

api-rest bootstrap css involvement-api javascript movies-website tvmaze-api

Last synced: 1 day ago
JSON representation

🎥 TVMaze is a website where you can see top shows related info, like them, and add comments. | Microverse's Module 2 - Group Capstone Project. Check it out! 👇

Awesome Lists containing this project

README

        


tv-maze-logo

Movies Website


---

# 📗 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)

---

# 🎥 TV Maze website

**"TV Maze"** capstone project is about building a SPA web application based on an external API. We had selected an API that provides data about a topic that we liked and then we built the webapp around it. The webapp have 2 user interfaces.

### Learning objectives:

- Use JavaScript to make websites dynamic and build basic single page apps.
- Use ES6 syntax.
- Use ES6 modules.
- Use callbacks and promises.
- Use webpack.
- Apply JavaScript best practices and language style guides in code.
- Use AAA pattern for unit tests.
- Write units tests for a JavaScript app.
- Follow [Gitflow](https://github.com/microverseinc/curriculum-transversal-skills/blob/main/git-github/articles/gitflow.md).
- Solve simple git conflicts.
- Send and receive data from an API.
- Use API documentation.
- Understand and use JSON.
- Make JavaScript code asynchronous.
- Perform a code review for a team member.

---

## 🛠 Built With

### Tech Stack

Client




API's


---

### Key Features


  • HTML & CSS3

  • JavaScript

  • Linters

    • Lihgthouse

    • StyleLint

    • ESLint



  • Webpack 5

  • Follow Microverse's list of best practices for JavaScript projects.

(back to top)

---

## 🚀 Live Demo

- 🎤 [Project presentation: video demo](https://drive.google.com/file/d/1-eSDabquIJCbvbQblqBPvSwbDIvaRfIb/view?usp=sharing)

- [Live Demo Link](https://iturres.github.io/TVmaze-movies-website/dist/)

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


  • A modern browser (supports html5)




  • Git and a GitHub account


### Setup

Clone this repository to your desired folder by using this 👇️ command :

```
git clone https://github.com/ITurres/TVmaze-movies-website.git
```

### Install

Install this project with:

```
npm install
```

### Usage

```
npm run start
```

### Run tests

```
npm test
```

### Deployment

- Not aplicable.

(back to top)

---

## 👥 Authors

👤 **Arthur Iturres**

- GitHub: [@ITurres](https://github.com/ITurres)
- Twitter: [@Arthur_ITurres](https://twitter.com/ArthurIturres)
- LinkedIn: [Arthur Emanuel G. Iturres](https://www.linkedin.com/in/arturoemanuelguerraiturres/)

👤 **Ruth Abreu**

- GitHub: [@Ruthmy](https://github.com/Ruthmy)
- Twitter: [@rury_exe](https://twitter.com/rury_exe)
- LinkedIn: [LinkedIn](https://linkedin.com/in/ruth-abreu)

(back to top)

---

## 🔭 Future Features

- [ ] Migrate to React TypeScript.

(back to top)

---

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

(back to top)

---

## ⭐️ Show your support

If you like this project and know someone who might find it helpful, please share it.
Or give it a **star** ⭐️

(back to top)

---

## 🙏 Acknowledgments

I thank Microverse for this fantastic opportunity, the code reviewers for their advice and time, and my excellent coding partner and team member [@Ruthmy](https://github.com/Ruthmy) 🏆

(back to top)

---

## 📝 License

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

(back to top)

---