🚀 Getting Started
📝 Overview
Three App is a set of utility functions that makes working with three.js more declarative and functional. It provides a solid starting point for 3D projects by reducing boilerplate and helping organize your codebase more effectively.
This experimental toolkit simplifies three.js app development through a collection of composable helpers. The goal is to offer a developer experience similar to React Three Fiber, while staying framework-agnostic, native, and minimal.
🌍 Try It Online
You can try Three App directly in the browser with no setup required:
📂 Scaffolding Your Project
You can scaffold a project using Parcel or Create Vite with the vanilla template:
npm create vite@latest my-three-app -- --template vanilla-ts📥 Installation
npm i three @slzr/three-app🧩 Three.js Compatibility
Three App is compatible and tested with three.js r175 and requires r158 or higher.
If you're upgrading from an older version, check the release notes and the migration guide for potential breaking changes.
🔷 TypeScript Support
Three App is fully type-safe out of the box. Since three.js doesn’t ship with types, install them manually:
npm i -D @types/three🚦 Before You Start
You should have at least a basic understanding of how three.js works to use Three App effectively.
📚 Recommended Learning Material
- Three.js - Official Documentation
- Three.js - Fundamentals
- Discover Three.js
- Bruno Simon's Three.js Journey
- SB Code - Three.js and TypeScript Tutorials
- Codrops - Three.js Posts