iTwin.js

An open source library for creating, querying, modifying, and displaying Infrastructure Digital Twins.

About this Repository

This repository is a monorepo that holds the source code to multiple iTwin.js npm packages. It is built using Rush.

See rush.json for the complete list of packages and Versioning.md for package and API versioning policies.

Each package has its own node_modules directory that contains symbolic links to common dependencies managed by Rush.

Features

• ✅ Create infrastructure digital twins of assets or projects
• ✅ Aggregate Engineering Models, Reality Data, Geographic Information Systems, Internet of Things (IoT) Data, and other standard formats
• ✅ Visualize data and engineering changes in 3D and 4D
• ✅ Analyze data to gain insights and drive new business outcomes across multiple platforms

Quick Start

• This is a sample of an iTwin viewer - a frontend application that displays infrastructure projects on browsers. It uses many of the APIs and libraries published from this repository.
• You can also look at other samples which showcases the capabilities of iTwin.js, and the iTwin Platform.

Prerequisites

• Git
• Node: an installation of the latest security patch of Node 20. The Node installation also includes the npm package manager.
• pnpm: our required package manager. It is more performant and monorepo friendly than npm. We recommend installing pnpm using corepack enable pnpm. Note you may have to use an administrator shell to run the command.
• Rush: to install npm install -g @microsoft/rush
• TypeScript: this is listed as a devDependency, so if you're building it from source, you will get it with rush install.
• Visual Studio Code: an optional dependency, but the repository structure is optimized for its use

See supported platforms for further information.

Contribution

Developer Quick Start

The following instructions will quickly set the repo up for you to edit the source code and contribute:

1. Clone the repository locally: git clone https://github.com/iTwin/itwinjs-core.git
2. Install dependencies: rush install
3. Build source: rush build
4. Run tests: rush cover

For more information, our Contributing guide contains detailed instructions on typical source code editing workflows, our contribution standards, FAQs, instructions on how to post questions and et cetera.

Licensing

Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.