build-threejs-app

Three.js Boilerplate

A boilerplate/starter project for quickly building three.js app using Vite & Three.

Quick Start:

To create a project, simply run:

npx build-threejs-app@latest <project-name>

Change directory:

cd <project-name>

Install the dependencies:

npm install

Run app in development:

npm run dev

Dependencies:

Package	Version
vite
three
events
vite-plugin-glsl
gsap
dat.gui

Project Structure:

public\
  |--models\          # Contain 3d models
  |--textures\        # Contain textures
src\
  |--constants\       # Contain environment variables and configuration related things
  |--helpers\         # Contain helper classes & functions
  |--scenes\          # Contain scenes & its objects
  |--shaders\         # Contain custom shaders
  |--utils\           # Contain utility classes & functions
  |--Camera.js        # Handle cameras
  |--Experience.js    # Handle experience & scenes
  |--Renderer.js      # Handle renderers
index.html            
main.js
style.css             # Custom styling