Getting started (offline quick start)

1. Get the tools

Writing an iTwin.js application requires the following software:

  • Node.js (14.x LTS version)
    • This provides the backend JavaScript runtime.
    • The installation also includes the npm command line tool.

2. Get the code

The starter application is located in the desktop-starter repo on GitHub. It is an example of an Electron based application and comes with a sample snapshot iModel.

git clone

3. Build and run a sample app

npm install

npm start


Next Steps

Create a snapshot iModel from your local data.

Open your snapshot iModel in the desktop-starter app by clicking the home button in the upper left and clicking "Select snapshot".

Follow tutorials to dive deeper into iTwin.js

iTwin.js Blog

Last Updated: 16 June, 2021