elasfarc / game-rating

A project that displays all the Civilizations of the Age of Empires II in combination with Involvement API to provide users with a social platform where they can discuss their opinions on AOE2 Civilizations.

Game Rating

A lightweight JavaScript project that displays all the Civilizations the Age of Empires 2 Definitive Edition has to offer. All the data is retrieved from the AOE2 Civilizations API, and used in combination with Involvement API to allow users an interactive website to discuss and support their favorite civilizations.

Project Description

This project combines the use of JavaScript, HTML/CSS and Bootstrap to provide users with a fully responsive app that is updated dynamically. The project is compiled using Webpack to ensure stability and longevity.

Using this project, users can interact with each other via the comments section, or by leaving likes on the civilizations that they support.

The main landing page displays a grid of item cards, which has the banner of the civilizations on the top, the name of the civilization underneath the banner, a "likes" button, and a "comments" button.

Users can click on the "comments" button on each of the civilizations to open up a pop-up screen that displays the detailed information, comments section and a text area to leave a new comment.

The "likes" button serves both as a counter and a button for users to show their support by liking the civilizations that they like to play. Users are free to leave as many likes as they wish, there is no limitation on the number of likes one user can submit.

Screenshots of the page

Live Version

Click Here

Video Description

Link

Built With

• HTML
• CSS
• JAVASCRIPT
• BOOTSTRAP

Getting Started

1. Open Terminal.
2. Navigate to your desired location to download the contents of this repository.
3. Copy and paste the following code into the Terminal: git clone https://github.com/elasfarc/game-rating.git
4. cd game-rating.
5. Install the required node modules by running npm install command.
6. If you're planning to test the project locally, you need a CORS app. Visit this link and request temporary access to be able to use this app on your own system.
7. After installing all the required node modules, you can run the project on your own server using npm run start or just use the index.html file to preview it.

Contributors

👤 Onur Onat Surmeli

• GitHub
• Twitter
• LinkedIn

👤 Mohammed Al-Asfar

• GitHub

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Thank you

Thank you for taking your time to view this project, we hope you enjoyed it! See you later in the next one!

game-rating's Issues

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

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

update the number of likes

clicking the like button ----> will increase the no. of likes
Click on the same like button again -----> will not increase the number of likes even though the like POST submitted successfully you can see the updated number only after reload

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

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

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

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

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

[0.5pt] Add header - group task

Create page header according to the wireframe:

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

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

[0.5pt] Add footer - group task

Create footer 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.

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

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

Project setup: 2-people team

Project link: https://github.com/elasfarc/game-rating

Good day, we have a team of 2 to work on this project.
Student A: Onur Onat Surmeli
Student B: Mohammed Al-Asfar

Thank you for your time.

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

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

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

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

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

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