Skip to content

j1m-ryan/threejs-starter-bun

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🪵 Three.js Starter with Bun, TypeScript & Vite 🚀

Screencast.from.2023-12-26.15-59-45.webm

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:

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

Navigate to the repository directory:

cd threejs-starter-bun

Install dependencies using Bun:

bun install

Usage 🚀

Start the development server:

bun run dev

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

Building Your Project 🏗️

To build the project for production:

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.

About

ThreeJS Starter Repo, with Bun, Vite and Vanilla TypeScript

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published