Need help with r3f-template?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Epiczzor
261 Stars 23 Forks MIT License 14 Commits 0 Opened issues

Description

a starter project for react-three-fiber and some more useful packages

Services available

!
?

Need anything else?

Contributors list

No Data

r3f-template

If you are just starting off with react-three-fiber then this template is for you. I have done a basic setup and a few usefull packages along with it.

This project was bootstrapped with Create React App.

| Packages | Versions | | ------------- |:-------------:| | three | ^0.128.0 | | @react-three/fiber | ^6.1.2 | | @react-three/drei | ^5.1.2 | | @react-spring/three | ^9.1.2 | | zustand | ^3.5.1 |

Using this Template

make sure you run

npm install
after cloning this repostiory.

There is a basic example on the repository as well. It is the same example as seen on the react-three-fiber repository page.

More examples are coming soon !

Read more

Installed Packages

  • @react-three/drei
    – useful helpers for react-three-fiber
  • zustand
    – state management
  • react-use-gesture
    – mouse/touch gestures
  • aphrodite
    – Support for colocating your styles with your JavaScript component. ~~-
    r3f-perf
    – Easily monitor the performances of your React-Three-Fiber application~~ was causing frame drops use from 'drei' instead
  • react-three-gui
    – GUI/debug tools

Showoff

Available NPM 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.

npm run build

Builds the app for production to the

build
folder.\ It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\ Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you

eject
, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can

eject
at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except

eject
will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use

eject
. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build
fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.