kendoriddy / beefland-eatery Goto Github PK

The BeefLand web application displays a list of meals that were provided by an external API. The users can like a meal, leave some comments or make a reservation, in these cases an involvement API was used. N.B. The reservation functions are not implemented because there are just two in the group.

Home Page: https://kendoriddy.github.io/BeefLand-Eatery/

License: MIT License

HTML 5.97% JavaScript 67.28% CSS 26.75%

webpack css html javascript

beefland-eatery's Introduction

BeefLand Menu

N.B. The reservation functions are not implemented because there are just two in the group.

This is the second Microverse capstone project meant to summarize all the content learned through module 2. The objective was to mimic the appearance of a dynamic web application, in a similar way a web developer would receive the requirements as if it were in a job.

Project requirements

Please find project requirements here.

Project presentation

Screenshot

Please take a look at the video below

Video Link

How it works

The BeefLand web application allows users to like, comment, and make a reservation for their favorite meal.

By clicking on like button the number of like is increased and stored in the involvement API;
By clicking on the Comment button to display the description of the selected meal, the list of all comments, and added a new comment;
By clicking on the Reservation button to display the list of all reservations and make a new Reservation;

Live Demo

Live Demo Link

Getting started

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

Prerequisites

A device that support running browser applications.
access to internet connection.

Setup

View pages from the browser

If you just want to check the webpage/webapp, you have it available on the live demo link.

Install locally the code of the application

In order to install a local version of this project and please do the following steps:

Install the latest version of any code editor.
install the latest version of GIT.
open your terminal
Go to the repository and clone it with `git clone [email protected]/kendoriddy/js-capstone.git' .
open the repository cloned with cd js-capstone
if your code editor is VsCode type code .
Install webpack with: npm install --save-dev webpack webpack-cli
To run it type nmp run start or run live server from the docs directory
To test it npm run test
and enjoy!

Technologies Used

CSS
HTML
JAVASCRIPT
Webpack
GitHub
VsCode
nodejs
GIT

Project Name

Description the project.

Authors

👤 Kehinde Onifade

GitHub: @githubhandle
Twitter: @twitterhandle
LinkedIn: LinkedIn

👤 Ghislain Mitahi

GitHub: @GhislainMitahi
Twitter: @GMItahi
LinkedIn: ghislainmitahi

🤝 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

beefland-eatery's People

Contributors

Watchers

beefland-eatery's Issues

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

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

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

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

Create footer according to the wireframe:

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

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