rayhantabase / pokedex

A simple web app that shows details concerning different Pokémon. Built using HTML,CSS, and JavaScript

Pokedex

A simple web app that shows details concerning different Amiibo. Built using HTML,CSS, and JavaScript. Users view a list of amiibo and have the possibility to like and comment on their favorite amiibo.

Video presentation

• Video

Screenshots

Built With

• HTML, JavaScript(ES6), CSS
• Webpack
• Tools used - Git(version control), WebHint(linting tool), Stylelint(style linting), ESLint(Javascript linting)

Live Demo

• Demo link

Software Requirements

• Node.JS
• npm
• Code Editor
• Git

Installation

• Clone the repo using the command below

git clone [email protected]:RayhanTabase/Pokedex.git

• Navigate to the directory in which you cloned the project and use the command below

cd Pokedex

• Install all project dependencies and packages using the command below

npm install

• Build the project using the command below

npm run build

• Start the server to run the application locally using the command below

npm start

Testing

• Install the repo using the instructions above

• Navigate to the directory in which you cloned the project and use the command below

cd Pokedex

• Enter the command below to test

npm test

Authors

👤 Salim Abdulai

• GitHub: @RayhanTabase
• Twitter: @RayhanTabase
• LinkedIn: Salim-Abdulai
• Email: [email protected]

👤 Charles Gobina

• Github:https://github.com/charlesgobina
• Twitter:https://twitter.com/i4mCloud
• LinkedIn:https://www.linkedin.com/in/charles-gobina-74a0ab193/
• Email: [email protected]

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

• Fork this repo using the command below

gh repo fork [email protected]:RayhanTabase/Pokedex.git

• Clone the forked repo using the command below

git clone [email protected]:RayhanTabase/Pokedex.git

• Navigate to the directory in which you cloned the project and use the command below

cd Pokedex

• Create a new feature branch using the command below

git checkout -b [name_of_feature_branch]

• Commit your changes using git commit as shown below

git commit -m ["enter a commit message"]

• Push your changes using

git push -u origin [name_of_feature_branch]

• Open pull request.

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.

pokedex's Issues

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

[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] 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 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] Add footer - group task

Create footer according to the wireframe:

Kanban Setup

Link to Project: https://github.com/RayhanTabase/Pokedex/projects/1

We are a team of two Micronauts (@charlesgobina and @RayhanTabase )

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

[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 comments counter - Student B

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

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

Peer to peer code review

You guys really did a great job implementing the functionalities.
The loading spinners also improve the user experience.

Suggestions

• The count of the numbers of movies displayed does not match with the actual number of movies displayed.
• The comments design needs a little touch

[0.5pt] Add header - group task

Create page header according to the wireframe:

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

[1pt] Choose assets - group task

Choose images, text, icons, fonts.

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

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

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