Skip to content

Sean-Bradley/Three.js-TypeScript-Boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Three.js TypeScript Boilerplate

This boilerplate is supplementary to ThreeJS and TypeScript courses at Udemy and YouTube (Channel membership required)

It is only just the beginning of what you will create.

Course Discount Coupons : https://sbcode.net/coupons#threejs

Boilerplate Overview

When run, the boilerplate shows a green wireframe rotating cube, with OrbitControls included.

Example

It uses webpack-dev-server for the development build, and NodeJS with Express for production build.

Both server and client projects are written in TypeScript.

Installing

  1. Clone Repository
git clone https://github.com/Sean-Bradley/Three.js-TypeScript-Boilerplate.git
  1. CD into folder
cd Three.js-TypeScript-Boilerplate
  1. Install TypeScript
npm install -g typescript
  1. Install dependencies
npm install
  1. Start it
npm run dev
  1. Visit http://127.0.0.1:8080

You should see a rotating green wireframe cube, and be able to rotate it further with your mouse.

  1. Edit project in VSCode
code .

Branches

The default master branch does not include Stats.js, Dat.GUI or Socket.IO

stats.js

To get a version of the boilerplate that includes the Stats.js panel then,

git checkout stats
npm install
npm run dev

Visit http://127.0.0.1:8080

With Stats.js

DAT.gui

To get a version of the boilerplate that includes the Stats and the Dat.GUI panels then,

git checkout statsgui
npm install
npm run dev

Visit http://127.0.0.1:8080

With Stats.js and Dat.GUI

Socket.IO

To get a version of the boilerplate that includes Socket.IO then,

git checkout socketio
npm install
npm run dev

Visit http://127.0.0.1:8080

With SocketIO

Open 2 or more browsers, and you can move the cube around and rotate it. You will see the cube mirror itself in the other browsers. Each browser controls there own cube.

Cannon.js

To get a version of the boilerplate that includes Cannon.js then

git checkout cannonjs
npm install
npm run dev

Visit http://127.0.0.1:8080

With Cannon.js

Webcam as Texture

To get a version of the boilerplate that uses your webcam as a texture then

git checkout webcam
npm install
npm run dev

Visit http://127.0.0.1:8080

With Webcam as Texture

BSC5 Bright Star Catalog

To get a version of the boilerplate that shows the BSC5 Bright Star Catalog Data with Constellations

git checkout bsc5
npm install
npm run dev

Visit http://127.0.0.1:8080

With BSC5 Bright Star Catalog

The Ball Game

The Ball Game is an example of a multiplayer game using Threejs, SocketIO and server side Cannonjs.

To get The Ball Game branch

git checkout ballgame
npm install
npm run dev

Visit http://127.0.0.1:8080

The Ball Game

Annotations

To get a version of the boilerplate that demonstrates annotations

git checkout annotations
npm install
npm run dev

Visit http://127.0.0.1:8080

With Annotations

Constructive Solid Geometry

To get a version of the boilerplate that demonstrates Constructive Solid Geometry (CSG)

git checkout csg
npm install
npm run dev

Visit http://127.0.0.1:8080

With CSG

WebXR

To get a version of the boilerplate that demonstrates WebXR

git checkout webxr
npm install
npm run dev

Visit https://127.0.0.1:8080

With WebXR


ThreeJS and TypeScript Course Introduction Video

This boilerplate was created as a sub project of my ThreeJS and TypeScript Course and is only just the beginning of what you will create.

ThreeJS and TypeScript Course

Games Created from this Boilerplate

Straight Car (SC)

Demo : https://sc.sbcode.net/

GitHub : https://github.com/Sean-Bradley/Straight-Car

Straight Car

Ball-VR

Demo : https://ball-vr.sbcode.net/

GitHub : https://github.com/Sean-Bradley/Ball-VR

Ball-VR

First Car Shooter (FCS)

Demo : https://fcs.sbcode.net/

GitHub : https://github.com/Sean-Bradley/First-Car-Shooter

First Car Shooter

TypeScript Books

To help support my projects, please check out my TypeScript books.

Design Patterns In TypeScript

   https://www.amazon.com/dp/B0948BCH24
   https://www.amazon.co.uk/dp/B0948BCH24
   https://www.amazon.in/dp/B094716FD6
   https://www.amazon.de/dp/B0948BCH24
   https://www.amazon.fr/dp/B0948BCH24
   https://www.amazon.es/dp/B0948BCH24
   https://www.amazon.it/dp/B0948BCH24
   https://www.amazon.co.jp/dp/B0948BCH24
   https://www.amazon.ca/dp/B0948BCH24
   https://www.amazon.com.au/dp/B094716FD6

(ASIN : B0948BCH24 / B094716FD6)