Getting Started

Getting Started

This page covers the common local setup path for Cindr3D.

Requirements

• Node.js 22.12.0 or newer
• npm
• A modern browser with WebGL support

The project is a Vite-powered React and TypeScript app. It can run locally during development or be built into static files for deployment.

Install

npm install

Run Locally

npm run dev

Open the local Vite URL printed by the command, usually:

http://localhost:5173

Fresh Dev Server

If Vite cache state looks stale:

npm run dev:fresh

Build

npm run build

The production output is written to:

dist/

The built app is a static single-page app. Any static host can serve it as long as unknown routes fall back to index.html.

Useful Checks

Run these before submitting changes:

npm run typecheck
npm run lint
npm run test:run
npm run build

During active development, the faster pre-check is:

npm run typecheck
npm run lint