chelmerrox / capstone-2

The Tasty Dishes site where users can view, like & comment on their favorite dishes. Built with HTML, CSS, vanilla JavaScript, Webpack, Meals API & the Involvement API.

Tasty Dishes

The Tasty Dishes site that users can view, like & comment on their favorite dishes. Built with HTML, CSS, JavaScript, Webpack, Meals API & the Involvement API.

Built With

• HTML5
• CSS3
• JavaScript
• Webpack
• Meals API
• Involvement API
• Postman
• Jest
• JestDom
• CommonJS
• Git
• Medium fidelity wireframe

Preview

Live Demo

Live Demo Link from ./dist/index.html

Video Presentation

Our Video Presentation

Getting Started

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

Prerequisites

• HTML5 & CSS3
• JavaScript
• Webpack
• VSCode (or any other text editor)
• Git
• GitHub
• Command line/Terminal

Setup

From the command line, do the following steps below:

1. Clone the projects' repository into your machine.

# Clone this repository
$ git clone [email protected]:chelmerrox/capstone-2.git

2. Change directory/Go into the repository with the command below.

$ cd capstone-2

3. Run this command.

$ npm run build

4. Run this to deploy the site on your local machine.

$ npm start

---

Instructions to disable CORS/Web security to see the site

1. For Windows OS & Google Chrome Browser, open your Windows Command prompt

2. Navigate to the file path where chrome.exe file exists

   a. Either in this file path

   $ C:\Program Files (x86)\Google\Chrome\Application
   

   b. Or this file path

   $ C:\Program Files\Google\Chrome\Application
   

3. To disable CORS & Web security to be able to see the site, run this command in the CMD. It opens a new unsecure instance of Google Chrome browser.

$ chrome.exe --user-data-dir="C:/Chrome dev session" --disable-web-security

4. Paste in the url of the site in the new unsecure instance (new window) of Google Chrome. (Use either the local host or the live version url provided)

Author

👤 Losalini Rokocakau

• GitHub: @chelmerrox
• Twitter: @chelmerrox
• LinkedIn: Losalini Rokocakau

Collaborators

👤 Shakhrizoda Yusupova | GitHub: @shyusu4

🤝 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

• Our God & families
• Microverse
• Morning Session Teams
• Stand-Up Team
• Microverse TSEs
• Meals API Documentation
• Involvement API Documentation

📝 License

This project is MIT licensed.

capstone-2's Issues

[0.5pt] Add footer - group task

Create footer according to the wireframe:

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

[1pt] Choose assets - group task

Choose images, text, icons, fonts.

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

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

[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] - 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] - 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] - Add tests for items counter - Student A

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

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

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

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

Make sure that function for the reservations 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.

Group capstone: set up your Kanban board

There are 2 people in our team:
Student A - @chelmerrox
Student B - @shyusu4

This is the link to our kanban board:
https://github.com/users/chelmerrox/projects/3

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