IFCjs / openbim-app-templates

TOC | documentation | demo | community | npm package

Open BIM app templates

This repository is a CLI command that allow to quickly start your next BIM application using OpenBIM Components and Vite.

Usage

Starting is really easy, just follow these steps:

• Install it globally with npm i -g openbim-app-templates.
• Create a folder anywhere you want and open it within your IDE.
• In the terminal of the opened folder, run create-openbim-app and follow the prompts.
• Run npm i and then npm run dev
• Go to the localhost provided by Vite and enjoy.

Templates

Currently, there are two templates available:

• React
• Vanilla
• Vue

Templates are using TypeScript as OpenBIM Components is written with it, so you can get typing help when developing your app. Keep in mind the templates are not full apps as they lack many of the functionalities from the library, but you can take them as a nice starting point to not going from the scratch.