From 86f34d9be364e12bed59bd79108f005948e21aca Mon Sep 17 00:00:00 2001 From: marco Date: Fri, 27 Oct 2023 12:57:03 -0600 Subject: [PATCH 1/3] :memo: update README --- README.md | 65 ++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 48 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 4075717..423813e 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,74 @@
-

Bon Appetito

+

🍕 Bon Appetito

View Demo -
+

+ + ![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)
-## 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 +
+ Click to expand! ![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) From 630725afb51da140cabe9bd64a069c22aea829da Mon Sep 17 00:00:00 2001 From: marco Date: Fri, 27 Oct 2023 12:57:58 -0600 Subject: [PATCH 2/3] :package: add keywords to package file --- package.json | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 3e4d251..e2c4bd6 100644 --- a/package.json +++ b/package.json @@ -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", From 5b3e2b471db464a98ae8ac9f71cf847ef54a8309 Mon Sep 17 00:00:00 2001 From: marco Date: Fri, 27 Oct 2023 12:59:25 -0600 Subject: [PATCH 3/3] :page_facing_up: add LICENSE file --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..51f373c --- /dev/null +++ b/LICENSE @@ -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.