Getting started
Install the project, run it on your computer, and make a production build. This takes about five minutes.
#Requirements
| Tool | Version | How to check |
|---|---|---|
| Node.js | 20.19 or newer, or 22.12 or newer | node -v |
| npm | Comes with Node.js | npm -v |
| A modern browser | Chrome, Edge, Firefox or Safari |
These are the lowest versions Vite 8 supports. If your version is older, install the current LTS release from nodejs.org.
The project includes an .nvmrc file. If you use nvm, run
nvm use inside template/ to switch to the right version.
#Install
- Unzip the download.
- Open a terminal in the
template/folder. - Install the packages:
cd template
npm install
This downloads about 400 MB of packages into node_modules/. It can take a
minute or two the first time.
#Run the development server
npm run dev
Open http://localhost:5192. You see the building overview, which is the default page.
The page reloads by itself when you save a file. Most changes to a component or a style appear without a full reload.
#Available commands
Run these inside template/.
| Command | What it does |
|---|---|
npm run dev |
Starts the development server on port 5192. |
npm run build |
Checks the types, then builds the site into dist/. |
npm run preview |
Serves the dist/ build on port 5192, so you can test it. |
npm run typecheck |
Checks the TypeScript types without building. |
npm run lint |
Checks the code with ESLint. |
npm run lint:css |
Checks the style sheets with Stylelint. |
npm run check |
Runs typecheck, lint and
lint:css together.
|
npm run format |
Formats every file with Prettier. It also sorts Tailwind classes. |
npm run format:check |
Reports files that Prettier would change, without changing them. |
#Make a production build
npm run build
npm run preview
npm run build writes the finished site into dist/. Upload
the contents of that folder to your web server. The
Deployment page explains the one server setting you
need.
#Look around the demo
A few places to start:
- Search everything. Press ⌘ K on a Mac or Ctrl K on Windows and Linux. The command palette searches all 77 pages.
- Change the look. Press the cog key at the bottom of the left sidebar. The Appearance drawer switches theme, density, light direction, key travel, motion and text direction.
- See every component. Open the Design kit key, the last key in the sidebar. It has 13 pages that show every component in every state.
- Sign in pages. Open the avatar key at the bottom of the sidebar and choose Sign out. The sign-in form accepts any email address and any password of eight characters or more.
#Your first changes
Most buyers change these first. Each one links to the page that explains it.
| You want to | Change this |
|---|---|
| Change the product name in the browser tab | The <title> in index.html |
| Change the name in breadcrumbs |
"product" at the top of
src/data/nav-manifest.json
|
| Change the logo |
src/components/ui/Mark.tsx. See
Theming.
|
| Change the main color |
src/styles/tokens/_roles.css. See
Theming.
|
| Change the fonts |
index.html and src/styles/tokens/_typography.css.
See Theming.
|
| Remove pages you do not need | See Pages and routing. |
| Use your own data | See Demo data and your API. |