Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/inglorious-ratbastard/zimmerleeats

Zimmerle Eats - Local Private Chef - Culinary Consultant | React/NextJS App
https://github.com/inglorious-ratbastard/zimmerleeats

cirrus-ui nextjs react react-dom reactjs vercel

Last synced: 9 days ago
JSON representation

Zimmerle Eats - Local Private Chef - Culinary Consultant | React/NextJS App

Awesome Lists containing this project

README 

        
### Zimmerle Eats - Personal Chef Services

#### **Chef Nick Zimmerle - San Antonio, TX**

#### *@zimmerleeats*

#### *#zimmerleeats*


##### Find me on social media and don't forget to *Like* and *Subscribe!*

![Facebook](https://img.shields.io/badge/Facebook-%231877F2.svg?style=for-the-badge&logo=Facebook&logoColor=white)

![Instagram](https://img.shields.io/badge/Instagram-%23E4405F.svg?style=for-the-badge&logo=Instagram&logoColor=white)

![YouTube](https://img.shields.io/badge/YouTube-%23FF0000.svg?style=for-the-badge&logo=YouTube&logoColor=white)

![TikTok](https://img.shields.io/badge/TikTok-%23000000.svg?style=for-the-badge&logo=TikTok&logoColor=white)

##### Dedicated to providing the highest quality product, made from the freshest ingredients available to satisfy your edacious palate.

___

###### ©2022 **Zimmerle Brews & Preserves/Zimmerle Eats**

###### **An IngloriousRat *Culinary Concept* Application** 

###### **React/NextJS - CirrusUI Web App** 


#### 
[Live Version](https://zimmerleeats.vercel.app/)


![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)

![Next JS](https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js&logoColor=white)

![SASS](https://img.shields.io/badge/SASS-hotpink.svg?style=for-the-badge&logo=SASS&logoColor=white)

![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white)

___

___

#### **About This Repo:**

##### The original concept was to build something modern and contemporary that suits the business model for Zimmerle Eats' ideas. What resulted was a very expressive yet polished design that accurately corresponds with entrepreneurial goals.



##### **Features:**

* ##### *Sophisticated design concept that uses React/NextJS and styled with Cirrus CSS/UI*  

* ##### *Interactive page components that both encourages and engages the users experience within* 

* ##### *Captivating product imagery that entices the customer to purchase the services rendered*

___

#### **Build Tools:**

##### **This project uses the following packages:**

##### [ReactJS](https://reactjs.org/docs/getting-started.html)

##### [NextJS](https://nextjs.org/docs/getting-started) 

##### [Cirrus CSS](https://www.cirrus-ui.com/docs)

##### [Vercel](https://vercel.com/docs)

___

##### Use the `npm run dev` command to run the development server or any of the built-in React Scripts listed below:



`"start": "react-scripts start",`


`"build": "react-scripts build",`


`"test": "react-scripts test"`



##### Note: This application is currently in development mode and it is *not* recommended to run the `build` script mode at his point. NextJS doesn't provide an `eject` script and instead recommends [custom webpack configuration](https://nextjs.org/docs/api-reference/next.config.js/custom-webpack-config) which should be done at your own discretion.

___

#### Deployment to Vercel:

##### About: The following explains how this app was deployed to [Vercel](https://vercel.com/docs) Cloud Hosting, assuming that you have already set up an account. 

* ##### Assure that your project has successfully been committed to **Github**, connect to a *Git provider* (GitHub, GitLab, or BitBucket). Any future changes made and pushed up will be directly reflected on **Vercel**.

* ##### From the Dashboard click on **New Project** to connect your *Github repo* and create your hosted application from the given options (or use a framework quickstart template). Click **Deploy** when ready to create your hosted application.

* ##### You can edit and/or change any of your **Project Settings** under the corresponding tabs within your *Dashboard*. 

* ##### If you have any global or secret keys you can create them by clicking on the **Environment Variables** tab and manually entering the proper values in the form boxes provided. Separate variables can be saved for both **Development** and **Production** modes.  

___

#### **Reporting Bugs or Issues:**

##### If you would like to report a **Bug** or **Issue** in this repo feel free to do so under the **Issues** tab or contact me directly about any major concerns. Ideas for improvements or enhancements to this project are also encouraged. Please address these matters by sending a **Pull Request** as they will be reviewed for potential consideration. 

___

#### Contributing:

* ##### **Clone** this repository and create a new branch:


 ##### `$ git clone https://github.com/inglorious-ratbastard/zimmerleeats.git -b name_of_new_branch`

* ##### Introduce a new feature, fix an existing bug, or clean up the current codebase

* ##### Throroughly **Test** the changes that have been implemented [*Jest* testing suite is preferred]

* ##### Submit a **Pull Request** that accurately explains the changes that were made to this repository

##### Your contribution will be reviewed and considered for *merge* into **Main** or a separate **branch**. 
 Thank you for assisting in the development and/or advancement of this project.

___