https://github.com/estete9/capstoneshowfinder

A single-page website that consumes the TVMaze API and helps users find information about their favorite series
https://github.com/estete9/capstoneshowfinder

Last synced: 5 days ago
JSON representation

A single-page website that consumes the TVMaze API and helps users find information about their favorite series

• Host: GitHub
• URL: https://github.com/estete9/capstoneshowfinder
• Owner: Estete9
• Created: 2023-09-04T15:24:37.000Z (over 1 year ago)
• Default Branch: dev
• Last Pushed: 2023-09-08T21:31:59.000Z (over 1 year ago)
• Last Synced: 2025-01-31T06:48:46.222Z (13 days ago)
• Language: JavaScript
• Size: 1.89 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




  

  


  
Show Finder - Capstone




# 📗 Table of Contents

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

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [Demo](#key-features)

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

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 Show Finder 

**Show Finder** Is a single-page webpage that consumes TVMazeAPI and InvolvementAPI. It uses the shows and involvement information to display it on the main screen or in the popups for the comments or the reservations.

## 🛠 Built With 

### Tech Stack 

  Client

  


    
HTML

    
CSS (including responsive design)

    
JavaScript for menu functionality

    
Webpack

  


Database

  


    
PostgreSQL

  


### Key Features 

- **[Responsive design for mobile and desktop]**

- **[Menu functionality using JavaScript]**

- **[Use of modules and libraries]**

## Live Demo

Visit us [here](https://estete9.github.io/CapstoneShowFinder/)

(back to top)


## 💻 Getting Started 

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

### Prerequisites

To run this project you need:

- VSCode

- npm

- Node

### Setup

Make sure you have VSCode, npm, and Node installed

### Install

In the root folder, run the script `npm install` to install all the libraries necessary.

### Usage

#### Webpack

Run the scripts:

- `npm run build` to have Webpack build the `dist` folder

- `npm run watch-webpack` to only have Webpack watch your files or

- `npm run watch` to watch the tests and Webpack changes

#### Live Demo

- Always run the script `npm run build-start` to see a live version of the project and be sure that all your assets and files are bundled by Webpack

### Run tests

Use the scripts:

- `npm run watch-jest` to only watch your tests with Jest or

- `npm run watch` to watch the tests and Webpack changes

(back to top)


## 👥 Authors 

👤 **Esteban Palacios**

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

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

- LinkedIn: [Esteban Palacios](https://www.linkedin.com/in/esteban-palacios-5030a772/)

👤 **M Alvee**

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

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

- LinkedIn: [M Alvee](https://www.linkedin.com/in/0xmalvee/)

👤 **Alejandro Maggioni**

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

- LinkedIn: [Alejandro Maggioni](https://www.linkedin.com/in/alejandro-maggioni-086678b5/)

(back to top)


## 🔭 Future Features 

- **Gallery popup**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page UPDATE URL HERE](https://github.com/Estete9/webpack-template/issues).

(back to top)


## ⭐️ Show your support 

If you like this project remember to star and share it 🥳️

(back to top)


## 🙏 Acknowledgments 

- ACKNOWLEDGMENTS TO CREATIVE LICENSE AND OTHERS

## 📝 License 

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

(back to top)