Skip to content

A minimal React Three Fiber boilerplate to help you get started with 3D web development. This template includes a basic scene setup with a rotating cube, proper lighting, camera controls, and responsive canvas.

Notifications You must be signed in to change notification settings

petercsipkay/Basic-React-Three-Fiber-Boilerplate

Repository files navigation

React Three Fiber Boilerplate

A minimal React Three Fiber boilerplate to help you get started with 3D web development using React. This template includes a basic scene setup with a rotating cube, proper lighting, camera controls, and responsive canvas.

Features

  • React Three Fiber integration
  • Basic Three.js scene setup
  • Responsive canvas
  • OrbitControls for camera manipulation
  • Proper lighting setup
  • Shadow support
  • Animation system with consistent timing
  • Fullscreen support
  • Clean project structure

Setup

Download Node.js. Run these commands:

# Install dependencies (only the first time)
npm install

# Run the local server at localhost:5173
npm run dev

# Build for production in the dist/ directory
npm run build

Project Structure

├── src/
│   ├── components/
│   │   └── Scene.jsx
│   ├── App.jsx
│   └── main.jsx
├── index.html
├── package.json
└── vite.config.js

Dependencies

  • React
  • React Three Fiber (@react-three/fiber)
  • Three.js
  • Vite (for building and development)

Resources

For more Three.js and React Three Fiber resources, tutorials, and tools, visit:

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Feel free to submit issues and enhancement requests!

Acknowledgments

This boilerplate is designed to provide a clean starting point for React Three Fiber projects. For more advanced features and resources, check out threejsresources.com.

Author

Peter Csipkay

About

A minimal React Three Fiber boilerplate to help you get started with 3D web development. This template includes a basic scene setup with a rotating cube, proper lighting, camera controls, and responsive canvas.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published