An open API service indexing awesome lists of open source software.

https://github.com/m-anwar-hussaini/pizza-menu

Pizza Menu is a simple React-based app the displays a short list of pizzas on the page with its details like name, price and ingredients.
https://github.com/m-anwar-hussaini/pizza-menu

git github react readme webpack

Last synced: 7 months ago
JSON representation

Pizza Menu is a simple React-based app the displays a short list of pizzas on the page with its details like name, price and ingredients.

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 Pizza Menu ](#-pizza-menu-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Pizza Menu

**Pizza Menu** is my first react project.

## 🛠 Built With

1. ✅ **React**

### Tech Stack

Markup


  • HTML

  • MD markup

Style


  • CSS

Dynamic


  • JavaScript

  • React

  • WepPack

### Key Features

- 🔰 **[React-based project]**
- 🔰 **[Well Code structure]**
- 🔰 **[Responsive]**

(back to top)

## 🚀 Live Demo

- ✅ [Click] to see live demo.

(back to top)

## 💻 Getting Started

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

1. Download or clone this [repostory](https://github.com/M-Anwar-Hussaini/Pizza-Menu).
2. Provide a modern web browser.

### Prerequisites

**In order to run this project you need:**

- ✔ [Git](https://git-scm.com/downloads) installed in your machine.
- ✔ Sign in or sign up to your [Github](https://github.com/) account.
- ✔ A professional editer such as [VS Code](https://code.visualstudio.com/download).
- ✔ An Updated web browser such as Google Chrome, you can download it from [here](https://www.google.com/chrome/).
- ✔ [Node.js](https://nodejs.org/en/download) installed in your machine.
- ✔ Stylelint
- ✔ ESLint
- ✔ WebPack

- ✔ ESLint

```sh
npm install --save-dev eslint@7.x eslint-config-airbnb-base@14.x eslint-plugin-import@2.x babel-eslint@10.x
```

- ✔ Stylelint

```sh
npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x
```

### Setup

- Clone this [repository](https://github.com/M-Anwar-Hussaini/Pizza-Menu) to your desired folder:

- Example commands:

```sh
cd [YOUR FOLDER]
git clone https://github.com/M-Anwar-Hussaini/Pizza-Menu.git
```

### Install

- Run the following command in the root directory of the project to install all dependecies.

```sh
npm install
```

### Usage

- To run the project, execute the following command:

```sh
cd [YOUR FOLDER]
git clone https://github.com/M-Anwar-Hussaini/Pizza-Menu.git
```

### Run tests

1. Stylelint

```
npx stylelint "**/*.{css,scss}"
```

2. ESLint ☑

```
npx eslint .
```

### Deployment

**This project is deployed by the author, no permission for deployment by any other client.**

(back to top)

## 👥 Authors

👤 **Mohammad Anwar Hussaini**

- 👤 GitHub: [@Anwar Hussaini](https://github.com/M-Anwar-Hussaini)
- 👤 Twitter: [@MAnwarHussaini](https://twitter.com/MAnwarHussaini)
- 👤 LinkedIn: [Mohammad Anwar Hussaini](https://www.linkedin.com/in/mohammad-anwar-hussaini-876638267/)

(back to top)

## 🔭 Future Features

- [ ] **[Unit test]**
- [ ] **[Responsive]**
- [ ] **[Deployment]**
- [ ] **[Use developer local storage]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/M-Anwar-Hussaini/Pizza-Menu/issues).

(back to top)

## ⭐️ Show your support

If you like this project, kindly drop a start for the [repository](https://github.com/M-Anwar-Hussaini/Pizza-Menu);

(back to top)

## 🙏 Acknowledgments

**I would like to thank the following individuals and organizations for their contribution to this project.**

- I would like to express my heartfelt gratitude to [**Jonas Schmedtmann**](https://github.com/jonasschmedtmann) for teaching the react course.

(back to top)

## 📝 License

This project is [MIT](LICENSE) licensed.

(back to top)