Git Product home page Git Product logo

mahdi-niazi / mk-italian-cuisine Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 2.81 MB

MK Italian Cuisine is a website that generates Italian foods where customer can reserve and comment the food. It also allows customer to like the food. All data is preserved thanks to the external Involvement API service.

Home Page: https://mahdi-niazi.github.io/Group-Capstone/dist/index.html

HTML 17.99% JavaScript 53.23% CSS 28.78%

mk-italian-cuisine's Introduction

logo

MK Italian Cuisine

๐Ÿ“— Table of Contents

๐Ÿ“– About the Project

MK Italian Cuisine is a website that generates Italian foods where customer can reserve and comment the food. It also allows customer to like the food. All data is preserved thanks to the external Involvement API service.

๐Ÿ›  Built With

Tech Stack

HTML
CSS
Javascript

Key Features

  • Add Linters
  • Use Gitflow
  • Use API

(back to top)

๐Ÿš€ Live Demo

Live Demo Link
Video Demo Link

(back to top)

๐Ÿ’ป Getting Started

Prerequisites

In order to run this project you need text editor like VSCode.

Setup

Clone this repository to your desired folder:

  git clone https://github.com/Mahdi-Niazi/Group-Capstone.git
  cd Group-Capstone

Install

npm install npm run start

Usage

To run the project, open it through live server or double click the index.html

(back to top)

Run tests

To run tests, run the following command:

  • Track HTML linter errors run:
npx hint .
  • Track CSS linter errors run:
npx stylelint "**/*.{css,scss}"
  • Track JavaScript linter errors run:
npx eslint .

(back to top)

๐Ÿ‘ฅ Author

๐Ÿ‘ค Mohammad Mahdi Niazi

๐Ÿ‘ค Katherine Cendana

(back to top)

๐Ÿ”ญ Future Features

  • Add modal
  • Make the website responsive

(back to top)

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

โญ๏ธ Show your support

If you like this project feel free to follow this project and hit the star.

(back to top)

๐Ÿ™ Acknowledgments

-I would like to thank Microverse for helping me improve my skills in web design

(back to top)

โ“ FAQ (OPTIONAL)

  • How can I get a copy of the project and save it in my desktop?

    • You can download the whole folder and save it in your computer or you can clone this repository.

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

mk-italian-cuisine's People

Contributors

kccendana avatar mahdi-niazi avatar

Stargazers

Fatima Najafi avatar

Watchers

 avatar

mk-italian-cuisine's Issues

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

Screenshot 2021-06-27 at 22 10 45

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

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

Screenshot 2021-06-27 at 22 10 45

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 list of items on the Homepage - Student A

Create the main part of the homepage that keeps the layout from the wireframe:

Screenshot 2021-06-27 at 21 50 23

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.

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.