hfg43/js_capstone

This app displays a library of Tv Shows upon a search input. You can search for your favorite show or movie categories.

README

📗 Table of Contents

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

📖 [JavaScript Capstone - TV Shows]

This project is about the creation of a dynamic app, that shows in a responsive way a different selection of actual TV Shows, and giving a selection on demand by applying a search with your input desired.

[JavaScript Capstone - TV Shows] For this project, we have put into practice all we have learned during the JavaScript module. It was also our first pair programing project to be run this way, following project management tools as Kanban board and daily updates. In the technical part, we have applied Js best practicies using ES6 syntax & modules, use webpack, Gitflow and use 2 different APIs.

Find here video that shows the project details and functionality: (https://drive.google.com/file/d/174M16aVDuy5hUGUkCbcNxvBpU8lINgAJ/view?usp=drive_link)

🛠 Built With

Tech Stack

Client

• HTML

Style

• CSS

Dynamic

• JavaScript

Standar code

• Linters

Key Features

• [Use GitFlow]
• [Use Linters]
• [Use ES6 syntax]
• [Use JavaScript Modules]
• [Use Webpack]
• [Use Jest for testing]
• [Use Async/await functions]
• [Use TVmaze API]
• [Use Microverse Involvement API]
• [Use JSON]
• [Use Kanban board to set project milestones and follow up]
• [Work collaboratively doing pair programing]
• [Add a user friendly & responsive design]

(back to top)

(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:

Open on Visual Studio Code or any other code reader, and use an app as Live Server to review online.

Setup

Clone this repository to your desired folder:

git clone https://github.com/HFG43/JS_Capstone

Install

Open index.html file with your Code Editor, and review the behaviour of the page under different sizes. On the command Line run

npm install

to install dependencies in package.json. This will make the app work.

Usage

To run the project, execute the following command:

• In the command line: run "npm start"

Run tests

To run tests, run the following command:

No test available yet.

Deployment

You can deploy this project using:

([My portfolio deployment link] (https://hfg43.github.io/JS_Capstone/).

(back to top)

👥 Authors

👤 Hernán Güemes

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

(back to top)

👤 Lawrence Kioko

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

(back to top)

🔭 Future Features

• [Apply different ways to display elements on-demand]

(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, please Star it!

(back to top)

🙏 Acknowledgments

I will like to thank Microverse and their Code Reviewers!!

(back to top)

📝 License

This project is MIT licensed.

(back to top)

js_capstone's Issues

[0.5pt] Set up the project with Webpack and Jest- group task

• Set up Gitflow
• Set up webpack
• Set up a JavaScript testing library (Jest)

Peer to Peer code review - Morning session

Hi, @HFG43 👨‍💻

Congratulations! 🎉

You have really done an amazing job!
Your code looks perfectly fine and works as expected. ⭐

Highlights

✅ You used Gitflow correctly 👍
✅ Clean and understandable code 👍
✅ Using ES6 correctly👍
✅ API call correctly using Async functions 👍

Optional suggestions: ♻️

We really appreciate your effort in implementing the different functionalities in your code, 🥇 however there are some suggestions that we have for you that can help you improve 🎁 the user experience 🤵 on your webpage:

• We kindly suggest you have a search button to be able to filter and have the right movie selection or genre. This could be very helpful for users when looking for the series on the website.

[3pt] - 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.

[0.5pt] 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.

[4pt] - Display number of likes for each item on the Homepage - Student A

When the page loads, the webapp 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.

[1pt] Choose assets - group task

Choose images, text, icons, fonts.

[4pt] - Create feature: add new comment - Student B

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

When the user clicks on the "Comment" button, the data is recorded in the Involvement API and the screen is updated.

[4pt] -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 webapp retrieves data from the selected API and shows details about the selected item.

Add 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).

[3pt] - Add reservations counter - Student C

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

Make sure that the correct number is displayed on the Reservations 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.

[0.5pt] Add header - group task

Create page header according to the wireframe:

[3pt] - 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.

[4pt] - Create feature: add new reservation - Student C

Implement the "add new reservation" form on the Reservations pop up according to the wireframe:

When the user clicks on the "Reserve" button, the data is recorded in the Involvement API and the screen is updated

Peer to Peer to code review - Morning session

Congratulations @Kidd254 you have done a great job in this last Pull Request #33 👏🙌

Highlights ⚡

• ✅ Beautiful design. 🥇
• ✅ Used of ES6 📃

However, we would like to share with you a suggestion ♻️ that could make your project look even better.

• In module popUp.js:

In your popUp() function, you have this code <h3 id="comments-header">Comments (0)</h3> that displays the title of the comments section and the comments counter using the function commentsCounter(). It could be much better to enclose the comment counter in a span tag and update it directly from your commentsCounter() function instead of updating the entire content of the h3 tag.

It could be something like this:

in your popUp() function:

<h3 id="comments-header">Comments (<span id="comment-counter">0</span>)</h3>

and in your commentsCounter() function:

const commentsNumber = document.getElementById('comment-counter');
commentsNumber.innerText = ${comments};

This could save you from having to render the word 'Comments' every time the comment counter is updated, which could benefit good code structuring and performance.

[3pt] - 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.

This task does not include the counter of the comments.

[3pt] - 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.

[4pt] - Display Reservations pop up with selected item's details - Student C

Create a reservations popup only with the top section (displaying details of the selected item)

When the popup loads, the webapp retrieves data from the selected API and shows details about the selected item.

Add 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).

[3pt] - Display reservations for a given item on the Reservations pop-up - Student C

When the popup loads, the webapp retrieves data from the Involvement API to show the item's reservations.

This task does not include the counter of the reservations.

[3pt] - Add tests for items counter - Student A

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.

JavaScript Capstone Project Kanban

Thanks for your feedback!
We have assigned the initial tasks pending as requested!

Hi @prolajumokeoni ! Please find the correct link to the project!

Hi there!

Please find attached the link to our repo. We are a group of two.
https://github.com/HFG43/JS_Capstone/projects/1
Thanks in advance for your feedback!

@Kidd254 & @HFG43

[3pt] - Add tests for reservations counter - Student C

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

Make sure that you have tests for all edge cases.

[3pt] - Add tests for comments counter - Student B

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.

[4pt] - 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 webapp retrieves data from the selected API and shows the list of items on 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.
#26 #26

[0.5pt] Add footer - group task

Create footer according to the wireframe:

##22 (PR Approved)