Get Totems running locally

Start with the full development source. This walkthrough uses Yarn Classic consistently and does not assume a separate starter package is available.

Before you start

Open a terminal in the Totems folder containing package.json and yarn.lock. For this draft walkthrough, we recommend Node.js 24 and Yarn Classic 1.22.22. This is a chosen setup path, not a final support matrix or a guarantee that every development revision has been verified with it.

node --version
yarn --version

Keep a clean copy of the source or create a version-control branch before editing. Do not put credentials in the source folder to get the demo running; these examples use fixtures.

1. Install dependencies

yarn install --frozen-lockfile

Wait for a successful install. The frozen-lockfile option preserves the committed dependency resolution. If it fails, check the first error and confirm package.json and yarn.lock came from the same source snapshot before changing either file.

2. Start the demo

yarn dev

Open the local URL printed by Vite and leave the terminal running. The root route opens the sample dashboard. You may see Toumei branding in the current source; this is expected during development.

Try the Projects list and board, File Manager, Calendar, and Chat. Component examples provide smaller references when you need one control rather than a whole page.

3. Make your first change

Open src/routes/dashboards/DashboardHome.data.ts. In dashboardProfile, change just the workspace value:

workspace: "My workspace",

Save and return to the root dashboard. Its introduction should now use your workspace name. You have changed sample content without changing layout or chart behavior.

For a larger edit, use Project structure to follow a page's imports. Keep fixture IDs consistent when records refer to one another.

4. Check your workspace

yarn test
yarn lint
yarn build
yarn preview

Tests run once with Vitest; lint runs ESLint. The build checks TypeScript and creates Vite output in dist/. Preview serves that output locally. Open its printed URL and confirm your edit is present.

These commands are checks to run on your copy, not a claim that every future source revision has already passed. Read Build and deployment before publishing anything.

Choose your next change

Add a small page with Routes and navigation, adjust the appearance with Styling and themes, or replace fixtures using Demo data and services.

If installation or the first edit fails, use Troubleshooting. Avoid changing several unrelated files at once; a small first change makes problems easier to isolate.

What you provide for production

Your application supplies authentication, authorization, APIs, durable data, uploads, messaging, and payments. Keep secrets out of client code and enforce permissions on the server. Read Demo data and services for a practical integration sequence before turning an example into a live feature.