Getting Started With iModel.js
1. Get the Tools
Writing an iModel.js application requires the following software:
- Node.js (latest 10.x LTS version)
- The installation also includes the
npmcommand line tool.
- Google Chrome
- This is the source code control system for the iModel.js repositories.
The following tools are very helpful and highly suggested for working with iModel.js:
- Visual Studio Code
- This is the recommended editor and debugger for iModel.js applications.
- VS Code also supplies a graphical user interface for working with Git.
- The following VS Code extensions can also be quite helpful:
2. Register Yourself
Note: Skip to step 3, if you already have a Bentley User Account.
3. Register your Application
Once you have a Bentley User account, you will need to register the application you are about to create so it can access iModelHub.
There are two types of apps you can register:
An interactive application obtains information from an iModel and presents that information in a user interface.
iModel agents and services are apps that have no interactive user interface.
4. Create a Sample Project
Once you have a registered application, you will need an iModel. Our registration process makes it easy to create a new project in our “iModel Test Drive” organization, populate it with content, and give access to other developers.
The content can be either:
- Bentley supplied example content – Recommended if you are just starting out. Simply select an example from the Project Registration page.
- You can use your own – Follow these steps to format your content into a ‘Snapshot iModel’ (.bim) before proceeding to the Project Registration page below.
Note: The “iModel Testdrive” organization is intended for developer testing only. See this page for information about administering a CONNECT project in your own organization.
5. Get the Sample Code
The Github repositories for the applications described in step 3.
Simple Viewer App
An example of an interactive application which can:
- Embed an iModel.js viewport into your application to display graphical data.
- Browse iModel catalog and view element properties.
iModel Query Agent
An example of an agent application which can:
- Listen to changes made to an iModel on the iModelHub.
- Construct a 'Change Summary' of useful information.
- Node Package Manager (npm)
Please see the Community Resources page for the best places to get more help.