Installation

Using template repository

The easiest way to get started with Angular Three is to use the template repository

The template repository is kept up to date with the latest version of Angular Three.

Did you know?

If you have the Github CLI installed, you can use the gh repo create command to clone the template repository directly from the command line.

gh repo create <username>/<repository-name>
  --template angular-threejs/template
  --public
  --clone

Angular CLI

Angular Three provides an ng-add schematic to set up angular-three and its dependencies.

ng add angular-three

Nx

1. Install angular-three as a dependency

npm install angular-three
# yarn add angular-three
# pnpm add angular-three

2. Run the init generator to set up angular-three and its dependencies.

nx generate angular-three:init

Manual

1. Install angular-three and its dependencies.

npm install angular-three three ngxtension
# yarn add angular-three three ngxtension
# pnpm add angular-three three ngxtension

2. Install @types/three as a development dependency.

npm install --save-dev @types/three
# yarn add --dev @types/three
# pnpm add --dev @types/three

3. Turn on skipLibCheck in tsconfig.json file (if haven’t already)

{
  "compilerOptions": {
    "skipLibCheck": true
  }
}