ryan-j-parker / R3F-Template

A template for React Three Fiber apps. Includes a grid helper, 3D text, lights, animations, and more. Skip the boilerplate and jump straight into worldbuilding with this simple starting point!

React Three Fiber Base Template

This template provides an easy starting point for R3F apps.

Side-step the initial scene setup and dive right in.

Comes packaged with:

• Animated cube mesh with useFrame & onClick wired up
• Text3D with pre-imported custom font and matcap material
• A GridHelper and AxesHelper rendered as primitive objects
• Lights, managed orbit controls, and suspense with loading spinner fallback
• Dependencies:
  • R3F
  • R3Rapier
  • R3Drei
  • React Spring
  • Leva
  • Zustand
  • GSAP
  • Three

To start, simply run

• npm install
• npm start

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.