Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 update README #14

Merged
merged 3 commits into from
Oct 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Marco Antonio Cruz Gabino marco24cruz08@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
65 changes: 48 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,74 @@
<div align="center">
<h1 align="center">Bon Appetito</h1>
<h1>🍕 Bon Appetito</h1>
<a href="https://bon-appetito.netlify.app/" target="_blank">View Demo</a>
<br/>
<br/><br/>

![Version](https://img.shields.io/github/package-json/v/marcode24/bon-appetito?style=popout&logo=npm)
![GitHub CI Workflow Status](https://img.shields.io/github/actions/workflow/status/marcode24/bon-appetito/ci.yml?branch=main&style=popout&logo=testcafe&label=tests)
![GitHub repo size](https://img.shields.io/github/repo-size/marcode24/bon-appetito?style=popout&logo=github&label=repo%20size)
![GitHub](https://img.shields.io/github/license/marcode24/bon-appetito?style=popout&logo=github&label=license)
![GitHub Repo stars](https://img.shields.io/github/stars/marcode24/bon-appetito?style=popout&logo=apachespark&color=yellow&logoColor=yellow)
![Github repo views](https://img.shields.io/github/search/marcode24/bon-appetito/bon-appetito?style=popout&logo=github&label=repo%20views)
![GitHub last commit](https://img.shields.io/github/last-commit/marcode24/bon-appetito?style=popout&logo=git&label=last%20commit)
</div>

## Get started
## 🚀 Getting Started

Here you can buy or build your own pizza, choose the ingredients and the size of the pizza, and then you can order it.

### 📝 Requirements

- [![Angular](https://img.shields.io/badge/Angular-blue?style=popout&logo=angular&logoColor=red)](https://angular.io/)
- [![Node](https://img.shields.io/badge/Node-gray?style=popout&logo=node.js)](https://nodejs.org/en/)
- [![NPM](https://img.shields.io/badge/NPM-blue?style=popout&logo=npm)](https://www.npmjs.com/)
- [![Git](https://img.shields.io/badge/Git-gray?style=popout&logo=git)](https://git-scm.com/)

### Requirements
Optional tools:

- [Git](https://git-scm.com/downloads)
- [Angular](https://angular.io/cli)
- [Visual Studio Code](https://code.visualstudio.com/)
- [![Visual Studio Code](https://img.shields.io/badge/Visual%20Studio%20Code-blue?style=popout&logo=visual-studio-code)](https://code.visualstudio.com/)

### Clone the repo
### 📦 Installation & Usage

```shell
```bash
# Clone this repository
git clone https://github.com/marcode24/bon-appetito

# Go into the repository
cd bon-appetito

# Install dependencies
npm install

# Run the app
ng serve
```

### Install npm packages
shut it down manually with `Ctrl-C` or `Cmd-C`.

Install the `npm` packages described in the `package.json` and verify that it works.
## 📐 Tests

```shell
npm install
ng serve -o
```
```bash
# Run tests
npm run test

Shut it down manually with `Ctrl+C`
# Run tests with coverage
npm run test:cov
```

## Environments
## 🌎 Environments

| Name | URL | PORT |
| ---------- | ---------------------------------------------------------------------- | ---- |
| Localhost | [localhost](http://localhost:4200) | 4200 |
| Production | [https://bon-appetito.netlify.app/](https://bon-appetito.netlify.app/) |

## 📝 License

This project is under the [MIT](./LICENSE) license. See the LICENSE for more information. 😉

## Previews
<details>
<summary>Click to expand!</summary>

![home](https://res.cloudinary.com/dfeujtobk/image/upload/v1669689035/Bon%20Appetito/preview_q6thws.png)
![home](https://res.cloudinary.com/dfeujtobk/image/upload/v1669689036/Bon%20Appetito/payment_a6npef.png)
13 changes: 12 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
{
"name": "bon-appetito",
"version": "0.0.0",
"version": "1.0.0",
"keywords": [
"angular",
"typescript",
"eslint",
"husky",
"lint-staged",
"prettier",
"pizza",
"restaurant",
"food"
],
"scripts": {
"ng": "ng",
"start": "ng serve",
Expand Down
Loading