Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sean-bradley/three.js-boilerplate-ts-vite
https://github.com/sean-bradley/three.js-boilerplate-ts-vite
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/sean-bradley/three.js-boilerplate-ts-vite
- Owner: Sean-Bradley
- License: mit
- Created: 2024-04-06T09:31:46.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-04-24T20:44:12.000Z (7 months ago)
- Last Synced: 2024-05-02T02:14:21.218Z (7 months ago)
- Language: TypeScript
- Size: 161 KB
- Stars: 4
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Three.js-Boilerplate-TS-Vite
A Three.js Boilerplate for TypeScript Vite projects.
This boilerplate is supplementary to my **ThreeJS and TypeScript** courses at [Udemy](https://www.udemy.com/course/threejs-tutorials/?referralCode=4C7E1DE91C3E42F69D0F) and [YouTube (Channel membership required)](https://www.youtube.com/playlist?list=PLKWUX7aMnlEKTmkBqwjc-tZgULJdNBjEd)
[Introductory Video](https://youtu.be/cZWAqrJhtvQ&list=PLKWUX7aMnlEKTmkBqwjc-tZgULJdNBjEd)
[Course Discount Coupons](https://sbcode.net/coupons#threejs)
## Boilerplate Overview
When run, the boilerplate shows a multi-coloured wireframe cube, with `OrbitControls`, `Dat.GUI` and `Stats.js` included.
[Example](https://sean-bradley.github.io/Three.js-Boilerplate-TS-Vite/)
## Installing
```bash
git clone https://github.com/Sean-Bradley/Three.js-Boilerplate-TS-Vite.git
cd Three.js-Boilerplate-TS-Vite
npm install
```
### Develop
```
npm run dev
```
Visit [http://localhost:5173/](http://localhost:5173/)
### Build Production
```bash
npm run build
npm run preview
```
Visit [http://localhost:4173/](http://localhost:4173/)
### Deploy to GitHub pages
If you forked this repository, then you can publish your changes to GitHub pages.
```bash
npm run deploy
```
Visit `https://.github.io/Three.js-Boilerplate-TS-Vite/`
E.g.,
[https://sean-bradley.github.io/Three.js-Boilerplate-TS-Vite/](https://sean-bradley.github.io/Three.js-Boilerplate-TS-Vite/)