xsidx / js-capstone-group

A web application showing list of animes. Users are able to like on different individual anime which updates on real time.Users are able to add comments and reserve dates to watch a selected anime.

Anime

This is a web application showing list of animes. Users are able to like on different individual anime which updates on real time.Users are able to add comments and reserve dates to watch a selected anime.

Built With

• Major languages: HTML , CSS , JavaScript , Webpack, Involvement API, Jikan REST API.

Live Demo

Live Demo Link

Presentation Demo

You can see our video presentation here

Getting Started

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

Prerequisites

Before attempting to get a copy of this, you should know(have) how to do the following:

• How to use the command line interface(CLI)
• Know how to navigate directories or folders at the CLI.
• Know how to get the URL(https/ssh) of a repository on GitHub.
• You should have a code editor installed, preferably VsCode.

Setup

In desired folder or directory in the CLI, run the command:

              git clone (https://github.com/XsidX/js-capstone-group.git)

-Navigate into the cloned folder or repository by running the command:

              cd <folder/name of the repository>

• If VsCode is your default code editor, run:

              code .

• You are all setup!

Authors

👤 Shaqayq

• GitHub: Shaqayq
• Twitter: DarwaziShaqayq
• LinkedIn: shaqayq-darwazi

👤 Sidney

• GitHub: XsidX
• Twitter: _sid_o
• LinkedIn: Sidney Kaguli

👤 Fadahunsi

• GitHub: Fadahunsiseyi
• Twitter: Fadahunsiseyi_
• LinkedIn: fadahunsi-seyi-samuel

🤝 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!

Acknowledgments

-Hat tip to anyone whose code was used

• Inspiration
• etc

📝 License

This project is MIT licensed.

js-capstone-group's Issues

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

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

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

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

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

[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] - 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 reservations counter - Student C

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

[0.5pt] Add footer - group task

Create footer according to the wireframe:

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

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

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

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

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

Peer to peer code review July 28th 2022

• We should update the README.md file.
• We should make the likes update correctly https://github.com/XsidX/js-capstone-group/blob/development/src/modules/home.js#L11
• It would be better to immediately update the likes on the UI onClick.
• It would be better to immediately update the comment and reservation onSubmit

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

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

Kanban project link

Link to Github project: https://github.com/users/XsidX/projects/2/views/1

There are three people in this team:

• Student A: @shaqayq
• Student B: @XsidX
• Student C: @Fadahunsiseyi

[0.5pt] Add header - group task

Create page header according to the wireframe:

[1pt] Choose assets - group task

Choose images, text, icons, fonts.

Popup styling

• It would be better to match the popup styling to the base styling of the website.
• The reservations popup should not have the same content as the comments section.