Getting started (online quick start)

1. Get the tools

Writing an iModel.js application requires the following software:

  • Node.js (12.x LTS version)
    • This provides the backend JavaScript runtime.
    • The installation also includes the npm command line tool.
  • Google Chrome
    • This is the preferred tool for developing and debugging frontend JavaScript.
  • Git
    • This is the source code control system for the iModel.js repositories.

Suggested IDE

  • Visual Studio Code
    • This is the recommended editor and debugger for iModel.js applications.
    • VS Code also supplies a GUI for working with Git.

2. Get a sample iModel

Click here and use the registration dashboard to create a new iModel

3. Get the sample code

The samples are included in the imodeljs-samples repo on GitHub. For a complete list of samples see the README.

git clone

4. Configure

Edit imodeljs-samples/interactive-app/basic-viewport-app/.env.local

imjs_test_imodel = The name of your iModel created in step 2

5. Build and run a sample app

cd interactive-app

cd basic-viewport-app

npm install

npm run build

npm run start:servers


Next Steps

Follow tutorials to dive deeper into iModel.js

iModel.js Blog

Read imodeljs-samples READMEs, and review code

Last Updated: 15 October, 2020