https://github.com/j1m-ryan/threejs-starter-bun
ThreeJS Starter Repo, with Bun, Vite and Vanilla TypeScript
https://github.com/j1m-ryan/threejs-starter-bun
bun threejs typescript vite
Last synced: 8 months ago
JSON representation
ThreeJS Starter Repo, with Bun, Vite and Vanilla TypeScript
- Host: GitHub
- URL: https://github.com/j1m-ryan/threejs-starter-bun
- Owner: j1m-ryan
- Created: 2023-12-23T16:48:38.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-09T10:23:46.000Z (over 2 years ago)
- Last Synced: 2025-02-01T06:51:16.087Z (over 1 year ago)
- Topics: bun, threejs, typescript, vite
- Language: TypeScript
- Homepage: https://threejs-bun.jimryan.ie/
- Size: 9.79 MB
- Stars: 9
- 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 🚀
[Starter Scene](https://github.com/j1m-ryan/threejs-starter-bun/assets/20595836/c7e5c8f7-ea47-4ee3-b55c-403d4998c7a4)
## 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 📦
You can create a repo using the `Use this template` button the repo, or alternatively:
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.