https://github.com/kekkorider/threejs-shield
https://github.com/kekkorider/threejs-shield
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kekkorider/threejs-shield
- Owner: kekkorider
- License: mit
- Created: 2022-09-16T14:30:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-26T09:22:58.000Z (over 2 years ago)
- Last Synced: 2025-03-27T04:33:34.460Z (2 months ago)
- Language: JavaScript
- Homepage: threejs-shield.vercel.app
- Size: 1.32 MB
- Stars: 39
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ThreeJS starter
This is a general template for ThreeJS applications. It uses [ViteJS](https://vitejs.dev/) to create the bundle and [Tweakpane](https://github.com/cocopon/tweakpane) for live updates.
# Before we start
This has been developed with NodeJS `16.11.0`; it should work with other versions too, but in case something doesn't work I recommend to switch to version `16.11.0` with [nvm](https://github.com/nvm-sh/nvm).
## Setup
```shell
$ yarn install
```
## Develop
Run
```shell
$ yarn dev
```
then open a new browser window and navigate to `http://localhost:1234`
## Debug
The template uses dynamic imports to include the code to run the debug panel. To display it, simply append `#debug` to the URL, i.e. `http://localhost:1234#debug`.
## Build
```shell
$ yarn build
```