indiecodermm / js-capstone

In this website, users can view popular game characters, and interact with other users by liking and commenting on individual characters. Powered by Amiibo API and Involvement API.

📗 Table of Contents

• 📗 Table of Contents
• 💻 PixelBros
  • 🛠 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

💻 PixelBros

This is a capstone project we built at the end of JavaScript Module during our study in Microverse program.

PixelBros is a website where users can view high-quality images of popular retro game characters. Users can also like and comment on their favourite ones and see which characters are the most popular.

The website uses Amiibo API to get information about all popular Nintendo characters from popular franchises such as Super Smash Bros, the Legend of Zelda, and Mario. Whether you're a fan of Mario, Pokemon or any other beloved characters, you'll be able to find them on this website.

   

🛠 Built With

Tech Stack

• HTML, CSS, JavaScript
• Amiibo API: API for characters data
• Involvement API: API for user likes and comments
• Webpack: Module bundler
• Jest: Unit testing
• GitHub Project: KanBan Board for tracking the progress

Key Features

• Browse through all of the different retro game characters
• Like and comment on your favourite characters
• View other users' likes and comments

(back to top)

🚀 Live Demo

You can visit the Live Demo Website.

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

• Node.js

Setup

Clone this repository to your desired folder:

  cd my-project
  git clone https://github.com/IndieCoderMM/js-capstone.git .

Install

Install the dependencies with:

  npm install

Usage

To run the project, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm run test

Deployment

You can deploy this project using:

  npm run build

This will create a production ready build for website in the dist directory. You can then deploy this directory on the GitHub Pages.

👥 Authors

👨‍🚀 Hein Thant

• GitHub: @IndieCoderMM
• Twitter: @hThantO
• LinkedIn: hthantoo

👨‍🚀 Amanuel Worku

• GitHub: @AmanWorku
• Twitter: @Amexworku
• LinkedIn: LinkedIn

(back to top)

🎯 Future Features

These are the features we want to implement in the upcoming updates.

• Add a hero section
• Implement search feature
• Add reservations
• Add sort-by button

(back to top)

🤝 Contributing

We welcome any contributions to our website! If you have an idea for a new feature or have found a bug, please open an issue or submit a pull request.

Feel free to check the issues page.

(back to top)

💖 Show your support

If you like this project, please consider giving it a ⭐. We really appreciate your support. Thank you!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving us this opportunity to work together and work on a project to understand what we have learned.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

js-capstone's Issues

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

[1pt] Choose assets - group task

Choose images, text, icons, fonts.

Peer-to-peer code review

In this Issue :

Hi @IndieCoderMM ✋
Your project is looking very good and you did a great job but there are some improvements 👍 .

Highlights!

• Followed Gitflow✔️
• Good commit✔️
• No Linters errors✔️
• Professional readme✔️
• Webpack✔️

Suggestions

• Nice work Hein, I would suggest you reduce the number of items on your home page also please center your popup window on the screen and resize your popup images. Well done again. 💯
• I think it's better to keep the comments add before.
• I think is better to display the articles in the same order.

[0.5pt] Add header - group task

Create page header according to the wireframe:

[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.

[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.

[0.5pt] Add footer - group task

Create footer according to the wireframe:

Kanban Board Set Up

Project Link

There are 2 people in this project:

• @AmanWorku
• @IndieCoderMM

[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.

Peer-to-peer review Module 2 wk5

Highlight

• The way you module the code base is very impressive. 🥇
• The UI also looks great. 💯
• I suggest you make the Logo a link to direct users to the home page
• Also update your readme to reflect what the project is about
• In all the project adheres to the requirements. Keep it up 👍

[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.

[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.

[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.

[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

[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.

[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)

[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.

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

[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.

[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.