ThreeJS Webpack TypeScript GH-Pages ESlint Boilerplate

Headache-free boilerplate to get started!

Preview GitHub Pages

Getting Started

Installation

First, clone the repository

GitHub Template:

Just press on Use This Template button :D

Git:

git clone https://github.com/nyan-left/threejs-webpack-typescript-eslint-template

Install the dependencies

cd threejs-webpack-typescript-eslint-template
npm install

You are now ready to get to work!

ThreeJS documentation.

Starting Development

The template is a fully-working example, so you may try it right away. You may start up the development server using

npm run dev

This starts an HTTP server listening on localhost and open up your default browser.

Building

To make a production build, simply run

npm run build

Github Actions

This template contains three github actions:

build.yml This runs on every push and creates a production build.

dependabot-auto-pr.yml This auto-approves pull requests generated by dependabot if the above action passes.

release.yml - When creating a new tagged release, will create a production build and push it to gh-pages branch.

Enjoy!