theMoviesMaze

The Movies Maze

📗 Table of Contents

• theMoviesMaze
• 📗 Table of Contents
• 📖 [theMoviesMaze]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 [theMoviesMaze]

[In theMoviesMaze, users can like Movies, TV Shows, and they can check out the details of every Movie or Show by clicking on the Comment Button. It also allows you to like the Movies. All data is preserved thanks to the external TVMaze API and Involvement API services. Fetching of the Movies, Details of the Movies, Adding and Getting Likes, and Comments Data are all preserved by the aforementioned APIs. Comment and Like buttons are there to update the Comments and Likes. Async & Await are also implemented along with some styling.]

🛠 Built With

Tech Stack

Client

• HTML, BootStarp, JavaScript, Webpack, API

Server

• Dev Server

Pakage Manager

• NPM

API

• Post Master

Key Features

• [Displays List of Movies, Likes, Details and Comments]
• [Addition of New Likes and Comments]
• [Number of Movies or Shows on Homepage, number of Likes, and number of Comments are all counted and being displayed along with the updation]
• [TVMaze and Involvement APIs are responsible for storage and retrieval of Data]
• [A Like and a Comment button is there to fetch all the Likes, Details, and Comments using APIs.]
• [Webpack is managing all the dependencies and auto loading in browser]
• [All the scetions and functionality is re-created by ES6 Modules]
• [Jest Tests and Coverage flags are implemented to test the Counters]

(back to top)

🚀 Live Demo

• Live Demo Link of our theMoviesMaze

• Live Video Link of our theMoviesMaze

(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 web browser to view output e.g Google Chrome.
• An IDE e.g Visual studio code.
• node should be installed in your local machine, node website.
• Install the npm package manager use this to install both node and npm.
• A terminal.

Setup

Clone this repository to your desired folder or download the Zip folder:

https://github.com/Mike111222/theMoviesMaze

• Navigate to the location of the folder in your machine:

you@your-Pc-name:~$ cd theMoviesMaze

Install

To install all dependencies, run:

npm install

Usage

To run the project, follow these instructions:

• After Cloning this repo to your local machine.
• Open the index.html in your browser.
• You can also use npm start command in terminal to run this at localhost:8080

Run tests

To run tests, run the following command:

• Track HTML linter errors run:

npx hint .

• Track CSS linter errors run:

npx stylelint "**/*.{css,scss}"

• Track JavaScript linter errors run:

npx eslint .

• run test:

npm test 

Deployment

You can deploy this project using: GitHub Pages,

• I used GitHub Pages to deploy my website.
• For more information about publishing sources, see "About GitHub pages".

(back to top)

👥 Authors

👤 Muhammad Amran Khan [Mike]

• GitHub: @githubhandle
• LinkedIn: LinkedIn
• Twitter: @twitterhandle

👤 Batool Fatima

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [More styles will be added to make my project look more beautiful and appealing.]

(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, just reach out to me for more projects even better than this, and please give it a star ⭐️.

(back to top)

🙏 Acknowledgments

I would like to thank my fellow Authors, my friend, my code reviewers and Microverse.

(back to top)

❓ FAQ (OPTIONAL)

• [How can the project be improved]

  • [More features can be intergrated by adding more pages]

• [Can I use this project for study purposes]

  • [Yes]

(back to top)

📝 License

This project is MIT licensed.

(back to top)