https://github.com/jossyboydgenius/3d-merry-xmas

https://github.com/jossyboydgenius/3d-merry-xmas

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/jossyboydgenius/3d-merry-xmas
• Owner: Jossyboydgenius
• Created: 2024-12-25T05:24:31.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-25T06:24:51.000Z (about 2 months ago)
• Last Synced: 2024-12-25T06:25:26.637Z (about 2 months ago)
• Language: JavaScript
• Size: 1.32 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 3D Merry Christmas



A 3D Merry Christmas project using Three.js and React Three Fiber.



## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

- [Deployment](#deployment)

- [Contributing](#contributing)

- [License](#license)

## Installation

1. Clone the repository:

   ```sh

   git clone https://github.com/Jossyboydgenius/3D-Merry-Xmas.git

   cd 3D-Merry-Xmas

   ```

2. Install dependencies using npm:

   ```sh

   npm install

   ```

3. Start the development server using npm:

   ```sh

   npm run dev

   ```

   Alternatively, install dependencies using pnpm:

   ```sh

   pnpm install

   ```

4. Start the development server using pnpm:

   ```sh

   pnpm run dev

   ```

## Usage

To start the development server, run:

```sh

npm run dev

```

or

```sh

pnpm run dev

```

Open your browser and navigate to [http://localhost:5173/](http://localhost:5173/) to see the project in action.

## Deployment

To deploy the project to Vercel, follow these steps:

1. Ensure your `pnpm-lock.yaml` is up to date:

   ```sh

   pnpm install

   ```

2. Commit and push your changes:

   ```sh

   git add .

   git commit -m "Update dependencies"

   git push

   ```

3. Deploy to Vercel:

   - Go to Vercel

   - Import your repository

   - Follow the instructions to deploy

## Contributing

Contributions are welcome! Please open an issue or submit a pull request.

## License

This project is licensed under the MIT License. See the LICENSE file for details.