buerli-examples

A collection of examples showing how to use the ClassCAD API in TypeScript.

First, clone the repository

git clone https://github.com/awv-informatik/buerli-examples
cd buerli-examples
yarn

Create an account and get your ClassCAD key

In order for buerli-examples to work, you need to have a running ClassCAD. You can either run it in the browser using WASM or connect to a local or remote ClassCAD server using SocketIO.

Running ClassCAD using WASM

Follow the instruction points 1-3 about "Create an account and get your ClassCAD key" on Getting Started with WASM.

Copy your created ClassCAD WASM key into the .env file at CLASSCAD_WASM_KEY= in the root of this project. The variable SOCKETIO_URL is not relevant in this case.

The first time ClassCAD starts using WASM, loading may take some time depending on your internet speed.

CLASSCAD_WASM_KEY=MS4xLlZZUG51....
SOCKETIO_URL=ws://localhost:9091

Running ClassCAD using SocketIO

Follow the instruction points 1-3 about "Create an account, get your ClassCAD key, download ClassCAD" on Getting Started with SocketIO

Start ClassCAD via SocketIO as described in the Downloads page

Open the .env file in the root of this project and comment out CLASSCAD_WASM_KEY to make sure ClassCAD is not running using WASM

#CLASSCAD_WASM_KEY=MS4xLlZZUG51....
SOCKETIO_URL=ws://localhost:9091

Run the examples

yarn dev

The examples application is now available at http://localhost:5173.

Please check the console output for possible node incompatiblities of the development tools. In case of problems, the use of nvm is recommended. nvm allows installing different Node versions on the same system.

Links to our homepages and documentations

• buerligons.io
• buerli.io
• classcad.ch
• awv-informatik.ch