CONTRIBUTING.md

Contributing Guidelines

Welcome to the contributing guidelines! Here you can find instructions on how to set up and contribute to the Svelte-HeadlessUI project.

The Project Structure

The project uses pnpm and comprises:

• src/docs contains the documentation in Markdown format
• src/routes are examples of the components in use
• src/lib is the code for the Svelte-HeadlessUI library

Setting Up The Project

From the root of the project install the project dependencies.

pnpm install

Build the project.

pnpm build

Contributing To Svelte-HeadlessUI

From the root of the project run the development server.

pnpm dev

You can open http://localhost:5173/ in your browser to see the UI components and make changes to the components, the documentation, or the examples.