TvMaze App

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 TvMaze App

TvMaze App is a single page app that fetches a list of shows from the TvMaze API. Users can search for a TV show and see its details.

🛠 Built With

Tech Stack

Client

Key Features

• Fetch and render TV shows.
• Search TV shows.
• Filter and render TV shows details.
• Responsive design.

(back to top)

🚀 Live Demo

• GitHub Pages

• Video presentation

(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 PC running any operating system like Windows, Linux, or MacOS
• An Internet connection
• Knowledge of some basic Git commands
• A browser like Brave, Google Chrome, Mozilla Firefox or Microsoft Edge
• Git installed

Setup

• Clone this repository to your desired folder:

git clone https://github.com/miltonHenschel/tvmaze-show.git

cd tvmaze-show

• Open the file in your code editor

code .

Install

• Node modules:

npm i

Usage

To run the project, execute the following command:

npm run dev

Run tests

To run tests, run the following command:

npm test

Deployment

You can build this project using:

npm run build

(back to top)

👥 Author

👤 Henschel Nketchogue M.

• GitHub: miltonHenschel
• LinkedIn: miltonhenschel
• Twitter: nketchogue

(back to top)

🔭 Future Features

• Improve design, include transitions and/or animations, etc.
• Implement additional pages in the website: about me, references, etc.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project then don't forget to give a star ⭐ on this repository.

(back to top)

🙏 Acknowledgments

I would like to thank:

• 
• Nelson Sakwa on Behance for the design guidelines of this app.

(back to top)

📝 License

This project is MIT licensed.

(back to top)