https://github.com/darkksideyoda/tauri-react-threefiber-vite

Developed with Tauri and React, a desktop 3D boilerplate starter template project.
https://github.com/darkksideyoda/tauri-react-threefiber-vite

3d-game boilerplate-template cross-platform desktop-app react react-three-fiber rust tauri tauri-app threejs tsx typescript vite vite-react

Last synced: 9 days ago
JSON representation

Developed with Tauri and React, a desktop 3D boilerplate starter template project.

• Host: GitHub
• URL: https://github.com/darkksideyoda/tauri-react-threefiber-vite
• Owner: Darkksideyoda
• Created: 2023-04-22T22:40:16.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-04-23T01:36:34.000Z (almost 2 years ago)
• Last Synced: 2024-11-13T19:40:55.912Z (2 months ago)
• Topics: 3d-game, boilerplate-template, cross-platform, desktop-app, react, react-three-fiber, rust, tauri, tauri-app, threejs, tsx, typescript, vite, vite-react
• Language: TypeScript
• Homepage:
• Size: 2.24 MB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# tauri-react-threefiber-vite



This is a desktop 3D boilerplate starter template project developed with Tauri and React. The project is configured with Vite and includes extra packages such as Tailwind CSS for styling, useSound for controlling audio, Prettier and ESLint for code formatting and linting, Zustand for global state management, and Framer Motion for simple animations.

## Getting Started

To get started with this project, simply clone the repository:

```console

git clone https://github.com/Darkksideyoda/tauri-react-threefiber-vite.git

```

and run the following command in the project directory

```console

npm install

```

After that, run the following command to start the development server:

```console

npm run tauri dev

```

Please note that the first run may be slow, but subsequent runs will be faster.

> **Note**

> After saying Play Demo, the ESC key becomes active. In this way, you can return to the main Menu again.

## Packages Included

The following packages are included in this boilerplate template:

- React Three Fiber

- React Three Drei

- Tailwind CSS

- useSound

- Prettier

- ESLint

- Zustand

- Framer Motion

> :warning: Update the configuration settings in the `src-tauri/tauri.conf.json` file according to your needs.

## Contributing

Contributions to this project are welcome. If you notice any issues or have any suggestions, please open an issue or a pull request.

## License

This project is licensed under the MIT License. See the LICENSE file for more information.