/ifc-hello-world

Minimal examples of open BIM application using IFC.js.

Primary LanguageJavaScriptMIT LicenseMIT

ifc.js | discord

Hello world IFC.js

opencollective

This repository contains the examples for the official documentation of IFC.js. You can visit it live here. It contains all the information regarding the project, including:

  • The motivation behind IFC.js.

  • Introduction to all the modules of the library.

  • API reference.

  • Step by step tutorials.

  • Informal articles of the authors.

  • Collaboration system and patreon.

  • Community highlight.

  • Link to social networks.

Quick setup

First, download this project or clone the repository and install the dependencies with git clone https://github.com/IFCjs/hello-world. You can then install the dependencies using npm install and build all the examples with npm run build. You can also build specific folders like this: npm run build -- web-ifc-three.

You can then execute the examples serving them locally with any library of your choosing (e.g. this one).

Content

All the examples are contained in the examples folder. It contains separate folders for each section of the library, as well as specific folders for examples that can't be classified in one module.