jonathanmunamire/movies-api

This Website is a Movies website, Built from API generated data and an Involvement API to help a user interact with movies of his choice

📗 Table of Contents

• MOVIES
• 📗 Table of Contents
  • 🛠 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
  • 📝 License

📖 [MOVIES]

This JavaScript capstone project is about building web application based on an external API. This project was done in a team of two members. We consumed tmdb api and Invlovement Api, and built a web app consisting two user interfaces.

🛠 Built With

Tech Stack

• JS
• Webpack
• HTML & CSS

Key Features

• User can add likes by clicking the heart icon next to the movie title
• User can view existing comments and add theirs using the form
• User can see the most popular movies

🚀 Live Demo

• Live Demo Link
• KanBan Board

Pull Requests

• Pull Request 1
• Pull Request 2
• Pull Request 3
• Pull Request 4
• Pull Request 5
• Pull Request 6

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Basic Knowledge of HTML, CSS, & JavaScript.
• Basic knowledge of ES6 syntax.
• Basic knowledge of Git, GitHub &Gitflow.
• Basic knowledge of Linters.
• Basic knowledge of Webpack.
• Basic knowledge of Jest unit-testing library.
• Basic knowledge of VS Code or any other code-editors.

Setup

Clone this repository to your desired folder:

  cd javascript-capstone
  git clone https://github.com/jonathanmunamire/Movies-Api.git

Install

Install this project with:

  npm install

Usage

To run the project, execute the following command:

  npm run dev

Run tests

To run tests, run the following command:

  npm run test

Deployment

You can deploy this project using:

  npm run deploy

👥 Authors

👤 Author1

• GitHub: @jonathanmunamire
• Twitter: @amanimunamire
• LinkedIn: Jonathan Munamire

👤 Author2

• GitHub: @Tamunokuro
• Twitter: @tamuno____
• LinkedIn: Joshua Blue-Jack

🔭 Future Features

• Search feature that user will use to navigate through the site
• Feature to redirect the user to the actual video of the movie
• User to be able to watch the movies from the site

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like this project and would like to have us contribute to your project, kindly shoot us a message to our individual handles above.

🙏 Acknowledgments

We would like to thank

• unsplash for providing inspiration behind our background image.
• canva for the logo.

📝 License

This project is MIT licensed.

movies-api's Issues

[4.0Pts]Display number of likes for each item on the Homepage - Student A

When the page loads, the web app the Involvement API to show the item likes and combines them with the data from the base API.

Remember that your page should make only 2 requests:

one to the base API
and one to the Involvement API.
This task does not include displaying the likes button (heart icon on the wireframe) for each item.

Peer to peer code review

Great job so far, but there are a few more things you need to adjust:-

• On this part 👇, kindly exercise using environment variables to store your API keys. Exposing your keys is considered a security glitch. Here's a step by step material that will help you understand this whole concept.

  Movies-Api/src/modules/addComment.js

  Line 5 in 5e2a328

  const API_KEY = 'OQzrUx0TOY2CTkVMSpNy';

[1.0Pts]Choose Assets - Group Task

Choose images, text, icons, fonts.

[0.5Pts]Add Footer - Group Task

[3.0Pts]Create feature: add new like - Student A

When the user clicks on the Like button of an item (on Homepage), the interaction is recorded in the Involvement API and the screen is updated.

[4.0Pts]Display Comments pop up with selected item's details - Student B

Create a comments popup only with the top section (displaying details of the selected item)
When the popup loads, the web app retrieves data from the selected API and shows details about the selected item.

Add an event to button prepared by your teammate that will open your popup. You need to communicate with your team member to make sure that you do not block each other (most likely the easiest solution is to merge the list of items feature to the dev branch before you try to add that event).

[3.0Pts]Add comments counter - Student B

Even if the API gives you the number of comments you will create a specific function to calculate it.

Make sure that the correct number is displayed on the Comments pop up.

Respect the following rules:

Each counter should be implemented as a separate module.
A counter function should look for specific DOM elements (e.g. for the comments counter it should look for comments) and make the counting based on what is actually displayed on the page.
A counter function should cover all the edge cases you can think about.

[4.0Pts]Create feature: add new comment - Student B

Implement the "add new comment" form on the Comments pop up according to the wireframe

[0.5Pts]Set Up the Project with WebPack and Jest - Group Task

• Set up Gitflow
• Set up web pack
• Set up a JavaScript testing library (Jest)

[4.0Pts]Display list of items on the Homepage - Student A

Create the main part of the homepage that keeps the layout from the wireframe
When the page loads, the web app retrieves data from the selected API and shows the list of items on the screen with the basic data (e.g. title + image).

Prepare also "Comments" and "Reservations" buttons. They should be doing nothing - just being displayed.

This task does not include displaying the number of likes for each item.

This task does not include the counter of the items.

[3.0Pts]Add all items counter on the Homepage - Student A

Even if the API gives you the number of items, you will create a specific function to calculate it.

Make sure that the correct number is displayed on the Homepage.

Respect the following rules:

Each counter should be implemented as a separate module.
A counter function should look for specific DOM elements (e.g. for the comments counter it should look for comments) and make the counting based on what is actually displayed on the page.
A counter function should cover all the edge cases you can think about.

JS Capstone Main Issue

• Link to the Project
• In This Project, We are 2 People : @jonathanmunamire and @Tamunokuro

[3.0Pts]Add tests for comments counter - Student A

Make sure that the function for the comments counter is covered with unit tests using Jest.

Make sure that you have tests for all edge cases.

[0.5Pts]Find external API - group task

Find an API to base the development of the webapp around it. The API should allow you to

Get a list of items with a unique item id (or generate the unique id).
For a given item, get detailed information about it.
choose an APIs that doesn't need authentication. if you select an API that requires authentication, you should implement it on your own. Also, if you select an API that provides image resources your webapp will be more visual.

[0.5Pts]Add Header - Group Task

Create page header according to the wireframe:

[3.0Pts]Add tests for items counter - Student B

Make sure that function for the items counter is covered with unit tests using Jest. Make sure that you have tests for all edge cases.

[3.0Pts]Display comments for a given item on the Comments pop-up - Student B

When the popup loads, the webapp retrieves data from the Involvement API to show the item comments.