https://github.com/ryanzam/the-coffee-cabin

A Coffee shop application using GSAP
https://github.com/ryanzam/the-coffee-cabin

gsap gsap-scrolltrigger reactjs tailwindcss vercel vitejs

Last synced: 10 months ago
JSON representation

A Coffee shop application using GSAP

• Host: GitHub
• URL: https://github.com/ryanzam/the-coffee-cabin
• Owner: ryanzam
• Created: 2025-06-29T09:55:04.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-07-02T12:05:28.000Z (12 months ago)
• Last Synced: 2025-08-08T01:51:29.217Z (11 months ago)
• Topics: gsap, gsap-scrolltrigger, reactjs, tailwindcss, vercel, vitejs
• Language: JavaScript
• Homepage: https://the-coffee-cabin.vercel.app
• Size: 24.6 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Coffee Cabin is a application built using React, Vite and GSAP (GreenSock Animation Platform)

![Vercel](https://vercelbadge.vercel.app/api/ryanzam/coffee-cabin)

## Technologies used

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

  ![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)

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

  ![GSAP](https://img.shields.io/badge/gsap-3.13.0-green)

## Table of Contents

- [Overview](#overview)

- [Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Installation](#installation)

- [Usage](#usage)

- [Development](#development)

- [Testing](#testing)

- [Contributing](#contributing)

## Overview

Coffee Cabin is a coffe shop application built using React and GSAP

## Getting Started

### Prerequisites

Ensure the following are installed on your system:

- **Node.js**: v18.x or later

- **npm**: v9.x or later

- **GSAP**: latest

- **Git**: For cloning the repository

### Installation

Follow these steps to set up the project locally:

1. **Clone the repository**:

   ```bash

   git clone https://github.com/ryanzam/coffee-cabin.git

   ```

2. **Navigate to the project directory**:

   ```bash

   cd coffee-cabin

   ```

3. **Install dependencies**:

   ```bash

   npm install

   ```

4. **Start the application**:

   ```bash

   npm run dev

   ```

## Usage

Access the application at `http://localhost:5173` after starting the server. 

## Development

- **Code Style**: Adheres to ESLint and Prettier standards for consistency.

- **Build**: Run `npm run build` to create a production build.

## Testing

Run tests using the included test suite:

```bash

npm test

```

## Contributing

Contributions are welcome! Please fork the repository, create a feature branch, and submit a pull request. Ensure code follows project standards and includes tests.