Kweeka1 / movies-app

Series Guide Application is a small application that displays some of the popular shows in the world. It also allows users to share their comments and feedback about their favored shows and give a thumbs up thanks to the external Involvement and TVMaze API services.

📗 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

📖 Series Guide Application

Series Guide Application is a small application that displays some of the popular shows in the world. It also allows users to share their comments and feedback about their favored shows and give a thumbs up thanks to the external Involvement and TVMaze API services.

Assessment links

• Kanban board
• PR - Mohamed Talbi
• PR - Sammy Ndabo

🛠 Built With

Tech Stack

• HTML
• SCSS
• Javascript
• Webpack

Key Features

• Display shows
• Display popup containing show's details
• Give feedback and thumbs up to your favorite show

(back to top)

🚀 Live Demo

• Open live demo

(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 to install these prerequisites:

• If you're running on Windows you can download the prerequisites from the links down below:

Nodejs

Git

• If you're running on Linux follow these steps down below:

• Install git.

 sudo apt install git

• Install nodejs and npm.

 sudo apt install nodejs

Setup

Clone this repository to your desired folder:

  git clone [e-mail]:Kweeka1/movies-app.git
  cd movies-app

Install

Install this project with:

  npm install

Usage

To run the project, follow below instructions:

• Take a unique id from the involvement api:

curl -X POST https://us-central1-involvement-api.cloudfunctions.net/capstoneApi/apps/
  -H 'Content-Type: application/json'

• Create a new file in root directory called .env and insert below code:

INVOLVEMENT_KEY={KEY_YOU_GOT_FROM_CURL_COMMAND}

• Example

INVOLVEMENT_KEY=0onO2DYOtlOD4dJgAQd1

• Now you can run the app by executing:

npm run start

Run tests

To run tests, run the following command:

  npm run test

Deployment

You can deploy this project using npm library called gh-pages:

• First install the library

npm install gh-pages --save-dev

• Then follow the instructions provided in their readme file to deploy the app

GH Pages README

(back to top)

👥 Authors

👤 Mohamed Talbi

• GitHub: Mohamed Talbi

👤 Sammy Ndabo

• GitHub: Sammy Ndabo

(back to top)

🔭 Future Features

• Add loading skeleton to show item cards
• Add a search bar to search for a specific show
• Add category links in the header section
• Load progressively show's comments

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for project inspiration.

(back to top)

❓ FAQ

• What version of nodejs does this project works on?

  • The project runs well with nodejs 14+. you might face some issues while running this project in lower versions.

(back to top)

📝 License

This project is MIT licensed.

(back to top)