https://github.com/vuquangpham/boil3js

A template for Three.js project
https://github.com/vuquangpham/boil3js

boil-collections boilerplate javascript template threejs

Last synced: about 1 month ago
JSON representation

A template for Three.js project

• Host: GitHub
• URL: https://github.com/vuquangpham/boil3js
• Owner: vuquangpham
• License: mit
• Created: 2023-09-29T18:03:01.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-31T09:27:35.000Z (9 months ago)
• Last Synced: 2024-10-15T08:49:02.227Z (3 months ago)
• Topics: boil-collections, boilerplate, javascript, template, threejs
• Language: JavaScript
• Homepage: https://boil3js.netlify.app/?debug
• Size: 3.07 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Three.js Boilerplate

> 🙌 Taken inspiration from Bruno Simon - the author of Three.js Journey course.

> ⚠️ This template is under construction and will be customized accordingly to my Three.js projects.

👉 Check it here!

## Setup

```shell

# Clone the template to your local or create a repository from this template

git clone https://github.com/vuquangpham/boil3js.git

# Install dependencies

npm install

```

## Getting Started

I did almost the necessary code for the Three.js project, you can check it inside the `src` folder.

### Debug

> Just add `?debug` to the end of your URL to get the debug panel 😉

## Deployment

Run `./public` in dev server

```shell

npm run dev

```

Build files to `./dist` for production

```shell

npm run build

```

Build files to `./dist` for production and preview

```shell

npm run buildpreview

```