======================================================================
🌱 threed.ai -- using React, Three JS, React Three Fiber, on Vite
This project contains a foundation for building and learning about React apps. The site includes two routes showing how navigation works in a single page app. We manage the page head and body using a standard React flow. The homepage features a click effect that demonstrates using state, and an animation you can try out yourself by following the steps in TODO.md.
React is a popular UI library for building web apps. Vite is a powerful tool for building javascript apps that bundles all of your code and shows immediate changes while you're editing.
While you're in the editor working, Vite is running your start script in the background (vite dev). The site will be in dev mode and you'll see your changes happen build script and Vite builds your app for modern browsers.
Live Demo
Prerequisites
You'll get best use out of this project if you're familiar with basic JavaScript. This project is a static site, which means that the server builds the site from the content of the src folder while you're developing it, then it's able to serve the pages super quickly when the user requests them.
What's in this project?
← README.md: That’s this file, where you can tell people what your cool website does and how you built it.
← index.html: This is the main page template React uses to build your site–it imports index.jsx to kick things off. When you're ready to share your site or add a custom domain, change SEO/meta settings in here.
← src/: This folder contains all the files React will use to build your site.
Working in the src/ folder 📁
React defines site components in JSX, an extended version of JavaScript, so you'll see lots of .jsx files in the project.
← src/index.jsx: This is the root of your React app. The index script is imported in the site home template index.html. If you add libraries like chakra-ui or redux, you'll insert their providers here. The <HelmetProvider> is an example of a provider you'd use.
← src/app.jsx: The base for defining your React app, this script imports the components that make up the site content. The index.jsx file imports the App script. The router (from wouter
← src/styles: CSS files add styling rules to your content. You have a lot of importing options for CSS including CSS modules if that's your jam.
← src/components/router.jsx: One of the most important parts of a single page app is the router. It's how we know what page to show–the code maps the paths to the Home and About components. We're using Wouter, a tiny minimalist router. You could replace it for something like React Router.
← src/components/seo.jsx: When you share your site on social media, you'll want to make sure the meta tags are correct and that you've got an image. All of the settings for this file are in src/seo.json.
Hooks 🪝
← src/hooks/: Hooks are a powerful way to provide interaction with your app.
← src/hooks/prefers-reduced-motion.jsx: For accessibility reasons, some users will indicate in their system settings that they prefer motion effects to be minimized–this allows you to hold off on these effects in such cases.
← src/hooks/wiggle.jsx: The wiggle effect animates elements, as you'll see if you hover over the image (or text below it) on the homepage. You can apply the effect anywhere you like in the site as outlined in TODO.md.
Pages 📃
← src/pages/: These files include components that specify the content of the Home and About pages. Each one is defined as a function and referenced in router.jsx. The content is built into the page outline specified in app.jsx.
← src/pages/about.jsx: The content of the About page, defined as a component function.
← src/pages/home.jsx The content of the Home page, also defined as a component function. The page includes the animated effect on hover, and title change effect on click (which is also a handy demo of using state data in React).
Try this next 🏗️
Take a look in TODO.md for next steps you can try out in your new site!
======================================================================
React Three Fiber on NextJS
🏯 React-Three-Next starter
Minimalist starter, First Load JS of 85Kb. This starter will automatically pick the marked R3F components and inject them into a canvas layout so we can navigate seamlessly between the pages with some dynamic dom and canvas content without reloading or creating a new canvas every time.
⚫ Demo :
How to use
Installation
Tailwind is the default style. styled-components (styled) is also available.
pnpm create r3f-app next my-app
# pnpm create r3f-app <next> my-app <tailwind|styled>? -ts?or
npx create-r3f-app next my-app🛂 Typescript
For typescript add the parameter -ts or --typescript:
pnpm create r3f-app next my-app -ts🗻 Features
- [x] Automatically inject r3f component in the Canvas
- [x] Support glsl imports
- [x] PWA Support
- [x] Layout for Canvas and DOM
- [x] Template for the meta data and header
- [x] Clean code using ESlint and Prettier
- [x] VSCode debug profiles for the server, Chrome, and Firefox
🚄 Architecture
Inform the nextjs page that the component is a Threejs component. For that, simply add the r3f property to the parent component.
const Page = (props) => {
return (
<>
<div>Hello !</div>
</>
)
}
// canvas components goes here
// It will receive same props as Page component (from getStaticProps, etc.)
Page.r3f = (props) => (
<>
<Shader />
</>
)
export default Page🎛️ Available Scripts
-
pnpm dev- Next dev -
pnpm analyze- Generate bundle-analyzer -
pnpm lint- Audit code quality -
pnpm build- Next build -
pnpm start- Next start -
pnpm export- Export to static HTML
⬛ Stack
-
threejs– A lightweight, 3D library with a default WebGL renderer. -
@react-three/fiber– A React renderer for Threejs on the web and react-native. -
@react-three/drei- Optional – useful helpers for react-three-fiber -
@react-three/a11y- Optional – Accessibility tools for React Three Fiber -
r3f-perf- Optional – Tool to easily monitor react threejs performances.