aimalamiri / javascript-group-capstone-project

The Meal Time website is our JavaScript project. It is about foods which is designed with Tailwind CSS based on two external APIs.

Meal Time restaurant website

The Meal Time website is our JavaScript capstone project. It is about building our web application based on two external APIs. We selected the Free Meal API by TheMealDB which provides data for meals to build the web app around it. We also used the Involvement API by Microverse to record likes and comments.

The web app has two user interfaces since we are a team of two:

• A home page showing a list of items that you can "like."
• A popup window with more data about an item that you can use to comment on.

In the future, we could add another interface to create reservations for a table at the restaurant.

You may read here the document with all the requirements for the project document.

Built With

• HTML 5
• SCSS 3
• Javascript ES6
• Webpack
• Jest (for testing)

Live Demo

• Live Demo Link

• Video presentation

Getting Started

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

Prerequisites

Open your terminal and navigate to the folder you would like to save the project.

Setup

Type these commands into the terminal:

• git clone https://github.com/aimalamiri/JavaScript-Group-Capstone-Project.git
• cd JavaScript-Group-Capstone-Project

You will need a .env file before you install and run the project. There is included an example file .env.example

• cp .env.example .env (if you are using Linux or macOS)
• If you work on Windows, you can use this command in Git Bash.

Install

Type this command into the terminal:

• npm install

Build

Type these commands into the terminal:

• npm run build
• Open dist/index.html in your web browser.

Run webpack dev server

Type these commands into the terminal:

• npm run start
• Your web browser will open on localhost:8080

Run tests

Type this command into the terminal:

• npm run test

Deployment

• npm run deploy

Authors

👤 Aimal Amiri

• GitHub: @aimalamiri
• Twitter: @meaimal
• LinkedIn: Aimal Amiri

👤 Roberto A. Baños Alvarez

• GitHub: @rbanos-mv
• Twitter: @RobertoBanosMV
• LinkedIn: Roberto A Baños Alvarez

🤝 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

• Free Meal API by TheMealDB
• Involvement API by Microverse
• Logo based on Pack de plantillas de logotipos de catering plano vector gratuito creado por freepik - www.freepik.es

📝 License

This project is MIT licensed.

javascript-group-capstone-project'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.

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

[1pt] Choose assets - group task

Choose images, text, icons, fonts.

Peer to peer code review

Great code, clean and efficient! Some suggestions to improve your code:

• You could reduce the HTML that you mock inside your test file.

Good job! 😄

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

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

Project and Issues setup

JavaScript Capstone Project Tasks Setup

Project Link: https://github.com/aimalamiri/JavaScript-Group-Capstone-Project/projects/1

We are 2 persons in our group @rbanos-mv and @aimalamiri

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

Make sure that function for the comments counter is covered with unit tests using 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.

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

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

Create footer according to the wireframe:

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

Morning session peer-to-peer code review

The project looks good, and the code looks very clean.

You use a lot of fetch requests. To maintain your code DRY, you could make a class that handles requests.

We noticed you're using some ES5 syntax for certain functions. Kindly replace these for ES6 functions in their stead.

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