Skip to content

Template for a React, MUI, Three.js, Electron, TypeScript and Vite project

Notifications You must be signed in to change notification settings

Sv443/React-Three-Electron-Template

Repository files navigation

React, MUI, Three.js, Electron, TypeScript & Vite Template


Setup:

  1. Click here to create a repository based on this template
  2. Clone your repository with git
  3. Run the command npm i to install dependencies

Commands:

Command Description
npm run dev Starts the vite dev server and the electron app
npm run lint Lint the code with ESLint
npm run build Compiles the TS code and builds the electron executable
npm run build-win Build for Windows only
npm run build-mac Build for MacOS only
npm run build-linux Build for Linux only

Files & Folders:

Path Description
src/App.tsx Main component of the app
src/objects/ Folder that contains all Three.js "object components" (meshes etc.)
src/components/ Folder for all other misc. React components
src/theme.ts Theme configuration
src/global.css CSS that is applied globally
electron/ Electron-specific code like creating windows and handling IPC

Additional info & guides & interesting packages

Main stuff

Helpful stuff

Other cool stuff

About

Template for a React, MUI, Three.js, Electron, TypeScript and Vite project

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published