Skip to main content
In this quickstart you write a small building as a document: four walls, a door, a window and a floor. Floorkit builds the 3D model from it. Then you move the door with one command. Use a modern browser and a Node.js version supported by Vite: 20.19+ or 22.12+. If you have a Vite TypeScript app already, skip the first step.
1

Create the project

Create a plain TypeScript app. No UI framework is required.
Follow Installation in this folder to install Floorkit and its peer packages. The template supplies the dev and build scripts used below.
2

Create the page

Put this in index.html:
3

Describe the building

Put this in src/main.ts. The document has one building with one storey. Positions are [x, z] in metres.
The wall path is the centre line of the walls. The floor outline is 0.1 metres outside that path, so the floor ends at the outer face of the 0.2 metre walls.
4

Build it and show it

Add this below the document. A BuildingSession builds the geometry. Its root is a Three.js group that you add to your scene. main gives back the session, so that the next steps can edit the building.
5

Run the app

Open the localhost address that Vite prints. You see a room with a door and a window. Drag to turn the view and scroll to zoom.Run npm run build to check the TypeScript and produce your app. A deployed hostname needs a valid license key.
6

Make your first edit

An edit is a command. This command moves the door one metre along its wall. Floorkit cuts the wall again and keeps the edit for undo. Add this at the end of src/main.ts.
Save the file. The page reloads, and the door is one metre further along the wall.

What you did

  • You wrote the building as a typed document. The door and the window are entries in their wall, and the wall has real openings for them.
  • You gave the document to a BuildingSession. It checked the document and built the geometry.
  • You changed the building with a command. You did not move a mesh.

Next steps

For generated building JSON, continue with the agent building workflow. For a saved project with views, sheets, and editors, use ProjectManager.

How Floorkit works

Learn the parts that you used.

Draw a wall

Start the modelling guides.

Create a plan view

Make a drawing from this room.

Export a PDF

Put the drawing on a sheet and export it.
Last modified on November 10, 2026