mrcbq / capstone-rick-and-morty-api

Web application created around Rick and Morty API, uses ES6 features and consume 2 API, one for get data (R&M API) another for post data (MV Involvement API). Permits add likes and comments taht are saved in the involvement API.

Capstone Rick and Morty - Microverse

📗 Table of Contents

• 📗 Table of Contents
• 📖 Capstone Rick and Morty
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Author
  • 🔭 Future Features
  • Walkthrough
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Capstone Rick and Morty

In this project we decide to consume the Rick and Morty API to make a web page to display characters in cards with popup window, characters descriptions, likes and section of comments.

• You can watch the description of the project here.

🛠 Built With

Tech Stack

• HTML
• JS
• CSS
• Webpack
• Jest

Client

- HTML
- JS
- CSS
- Webpack
- Jest

Server

- Null

Database

- Null

Key Features

• Cards with characters
• Popup windows
• Likes and comments for characters

🚀 Live Demo

You can see the live demo of this project here

(back to top)

💻 Getting Started

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

Prerequisites

• A web browser
• A code editor
• A terminal

Setup

Clone this repository to your desired folder:

  git clone https://github.com/mrcbq/capstone-rick-and-morty-api.git

Install

Install this project with:

  cd capstone-rick-and-morty-api
  npm install

Usage

To run the project on the webpack dev server, execute the following command:

  npm start

Run tests

To run tests, run the following command:

  npm test

Deployment

  npm run deploy

(back to top)

👥 Author

👤 Luis Valera

• GitHub: @Luiscarlosvd
• Twitter: @Luiscarlosvd29
• LinkedIn: Luis Valera

👤 Marco Baquero

• GitHub: @mrcbq
• Twitter: @mrcbq
• LinkedIn: mrcbq

🔭 Future Features

• Add popup window for reservations 😁
• Add Episodes section 👌
• Add more characters 😎

Walkthrough

You can watch the video description of the project here.

🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

⭐️ Show your support

If you like this project, give it a ⭐️!

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for giving us the opportunity to learn and grow as developers and also we like to thank our families, they are all our support. 🌟

(back to top)

📝 License

This project is MIT licensed.

(back to top)

capstone-rick-and-morty-api's Issues

[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

Kanban Board Review for Capstone Project

Hello Code reviewer! We are a team of 2 people for this capstone:
Student A - @mrcbq
Student B - @Luiscarlosvd
Link of Github Project: https://github.com/mrcbq/capstone-rick-and-morty-api/projects/1

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

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

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

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

code review morning - sesion

Hi Marco!

You have done an excellent job and your code is looking good but there are some things that you can improve! 😃

• Your code is clean and organized!
• The JavaScript file looks really nice, It's very compressed and easy to understand, congrats! 🥂
• You can try to fix the position of your footer, you could place it at the bottom of the page so that it looks more organized.👍

Keep it up and Happy coding!! 🎉🍾

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

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

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

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

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

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