https://github.com/j1m-ryan/threejs-animation

https://github.com/j1m-ryan/threejs-animation

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/j1m-ryan/threejs-animation
• Owner: j1m-ryan
• Created: 2023-12-23T20:00:58.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-12-23T20:37:01.000Z (about 1 year ago)
• Last Synced: 2024-10-12T12:39:17.309Z (3 months ago)
• Language: TypeScript
• Size: 277 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🌟 Three.js Starter with Bun, TypeScript & Vite 🚀

![cube](repo-assets/starter.gif)

## Introduction 📖

Welcome to the Three.js Starter Repo! This repository is designed to get you up and running with Three.js using the modern and efficient Bun runtime, TypeScript for type-safe code, and Vite for blazing-fast build times. Perfect for 3D web projects! 🌐

Features ⭐

- Three.js: Create beautiful and interactive 3D content. 🎨

- Bun: A fast, modern JavaScript runtime. 🐰

- TypeScript: Strongly typed programming language built on JavaScript. 🔒

- Vite: Next-generation frontend tooling. 

## Prerequisites 🛠️

Before you begin, make sure you have the following installed:

 - bun

## Installation 📦

Clone the repository:

    

```bash

git clone https://github.com/j1m-ryan/threejs-starter-bun.git

```

Navigate to the repository directory:

```bash

cd threejs-starter-bun

```

Install dependencies using Bun:

```bash

bun install

```

## Usage 🚀

Start the development server:

```bash

bun run dev

```

Open your browser and visit http://localhost:5173.

## Building Your Project 🏗️

To build the project for production:

```bash

bun run build

```

## Contributing 🤝

Contributions are always welcome! Feel free to open a pull request or an issue.

License 📄

This project is licensed under the MIT License.