Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/shubhcoding01/sccoffeeshop-code

ScCafe is more than just a coffee shop — it’s a journey to the perfect cup. Created with a passion for exceptional coffee and a commitment to convenience, ScCafe offers an innovative digital experience that makes ordering and enjoying coffee simpler than ever. With a clean, intuitive user interface, our platform ensures that you can easily explore
https://github.com/shubhcoding01/sccoffeeshop-code

html javascript nestjs node open-source react scrolltrigger tailwind-css

Last synced: 5 days ago
JSON representation

ScCafe is more than just a coffee shop — it’s a journey to the perfect cup. Created with a passion for exceptional coffee and a commitment to convenience, ScCafe offers an innovative digital experience that makes ordering and enjoying coffee simpler than ever. With a clean, intuitive user interface, our platform ensures that you can easily explore

Awesome Lists containing this project

README

        

# ScCafe ☕️


Since its inception in 2020, ScCafe has been committed to providing the finest coffee experience.
Our focus on exceptional beans and precision brewing has helped us build a strong community of coffee enthusiasts.
We take pride in sourcing our beans from environmentally conscious farms across the globe,
ensuring that every cup you enjoy is not only full of flavor but also ethically sourced and sustainable.

## Table of Contents
- [Project Overview](#project-overview)
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Installation](#installation)
- [Usage](#usage)
- [Screenshots](#screenshots)
- [Contributing](#contributing)
- [License](#license)

## Project Overview

ScCafe is a web application that offers an elegant, user-friendly interface for browsing our extensive coffee menu, placing online orders, and learning about our sustainably sourced beans.Whether you’re looking to order your favorite brew or learn more about coffee origins, ScCafe provides an excellent user experience for every coffee lover.

## Features
- **Browse Menu:** Explore our coffee varieties with detailed descriptions and pricing.
- **Sustainability Info:** Learn about our ethical sourcing and the farms we partner with.
- **Responsive Design:** The website is fully responsive for desktops, tablets, and mobile devices.
- **Order Coffee:** Add items to your cart and place orders (future feature).

## Tech Stack
- **Frontend:** React, CSS
- **State Management:** React Context API
- **Backend:** Node.js, Express (planned for future)
- **Database:** MongoDB (planned for future)

## Installation

### Prerequisites
Before you begin, ensure you have installed the following:
- [Node.js](https://nodejs.org/) (v14.x or higher)
- [npm](https://www.npmjs.com/) (v6.x or higher)

### Setup
Follow the steps below to set up the project locally:

#### Step 1: Clone the repository
```bash
# Clone the MsCafe repository
git clone https://github.com/your-username/sc-cafe.git

# Navigate into the project directory
cd sc-cafe
# Install the required npm packages
npm install
# Start the React development server
npm start
```
Once the server is running, you can view the app at (http://localhost:3000).
## Usage
-**To use the app:**
-**View Coffee Menu:** Browse through the available coffee items on the homepage.
-**Learn About Coffee:** Check out the sourcing section to learn more about our sustainably sourced beans.
-**Place an Order:** In future releases, you'll be able to add items to the cart and complete orders.

## ScreenShots:
## **Home Page:**
![Screenshot 2024-12-27 133144.png](https://github.com/shubhcoding01/SccoffeeShop-code/blob/main/Screenshot%202024-12-27%20133144.png?raw=true)
## **Coffee Menu:**
![Screenshot 2024-12-27 111725.png](https://github.com/shubhcoding01/SccoffeeShop-code/blob/main/Screenshot%202024-12-27%20111725.png?raw=true)
## Contributing
We welcome contributions! Follow the steps below to contribute to this project:
```bash
# Click the "Fork" button at the top-right of the repository page to create a copy in your GitHub account.
```
```bash
# Clone the forked repository to your local machine
git clone https://github.com/your-username/sc-cafe.git
```
```bash
# Navigate into the project directory
cd sc-cafe
```
```bash
#install dependencies
npm install
```
```bash
# Create a new branch for your feature or fix
git checkout -b feature/your-feature-name
```
```bash
# Make Your Changes
Make sure your changes adhere to the project standards and structure.
# Stage all changes
git add .
```
```bash
# Commit the changes with a descriptive message
git commit -m "Description of the feature or fix"
```
```bash
# Push your branch to your forked repository
git push origin feature/your-feature-name
```
```bash
# Go to the original repository on GitHub and open a new Pull Request
# Provide a clear description of your changes in the Pull Request.
```
Happy Coding
☕️