isabella232 / webgl-react-app

WebGL React App ⚡️

WebGL React App

The goal is this project is to standardise WebGL and React based projects at Jam3.

Building upon experience it features highly optimised approaches for rendering and scene management.

This is a great starting place for creative coders who want to jump straight into coding webgl.

Features

Flow

This Project uses Flow typing. A great place to start is with the docs or this cheatsheet.

Rendering

• Graphics profiling
• Preload objects on GPU
• Post Processing
  • FXAA as a replacement for antialising when using PostProcessing on WebGL 1
  • Film Pass for a more filmic look
  • Transition Pass for blending between two webgl scenes
  • Final Pass Combine multiple effects in a single shader
• Stats for fps and threejs for performance insights

Scenes

• BaseScene, an extendable class that enforces a clean scene pattern
• EventEmitter3 is used for event communication between classes

Cameras

• Helpers for creating perspective cameras and adding orbit controls

Lights

• Helpers added for Ambient Light, Directional Light, Point Light and Spot Light

Materials

• A material modifier inspired by three-material-modifier that can extend three's built in Materials with custom shader code

Interactions

• Touch Controls for normalizing mouse and touch events
• InteractiveObject adds interactivity to meshes

Asset Optimsing

• TextureOptimiser for compressing and resizing webgl textures
• ModelOptimiser for converting fbx models to gltf with draco compression

Asset Management

• AssetLoader for loading an array of assets with different types
• AssetManager for storing and retriving assets loaded with the AssetLoader

Precommit and Husky

Sometimes husky doesn't run if you're using Git software.

To check this, open the console output in your Git software and make sure the pre-commit hook isn't bypassed.

If husky isn't working create a ~/.huskyrc file and add:

# ~/.huskyrc
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"

References

• Threejs documentation
• Discover threejs Tips and Tricks

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

License

MIT

---

This project was bootstrapped with Create React App.

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.

npm 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 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 build fails to minify

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