Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.uifoundations.com/llms.txt

Use this file to discover all available pages before exploring further.

To get started with UI Foundations Kit you can open up the downloaded source code for you project and navigate into a root directory. The project is intentionally built to rely on few external dependencies and no external or 3rd party services, so your set-up time can be easy and painless.

Requirements

You’ll need a JavaScript package manager like npm, yarn, pnpm, or bun, any should work, but we use the default: npm in most cases. Inside the root directory of a project (where you find the package.json file), run the install command:
npm install

Edit and preview

To make changes and see them live, run the local server start script with:
npm run dev
This will open a port at a location noted in your terminal or shell, for Vite it’s http://localhost:5173. From here, you should see the landing page, and be able to open up the code in your favorite editor and begin to make changes.