sveltekit-headlessui-starter

Launch your next app with SvelteKit and Headless UI.

Usage no npm install needed!

<script type="module">
  import sveltekitHeadlessuiStarter from 'https://cdn.skypack.dev/sveltekit-headlessui-starter';
</script>

README

SvelteKit Headless UI Starter

Launch your next app with SvelteKit and Headless UI.

Highlights

  • 🏗️ SvelteKit beta for file system-based routing
  • 🏗️ Svelte for developing fast, lightweight apps
  • 🎨 Tailwind CSS with Forms and Typography plugins
  • 🧪 Headless UI for access to Tailwind UI elements
  • 💄 Prettier with Tailwind automatic class sorting
  • 🚩 Unplugin Icons to access to all Icônes icons
  • ⚡️ Cssnano for production stylesheet compression
  • 🦋 Changesets to manage versioning and changelogs
  • 📈 Basic SEO with large social sharing cards
  • 🚀 Vercel deployments no configuration needed

Demo

View the online demo to see what comes out of the box.

Developing

Once you've created a project and installed dependencies with pnpm install, start a development server:

pnpm run dev

# or start the server and open the app in a new browser tab
pnpm run dev -- --open

Adding a changeset

To add a changeset run pnpm changeset and follow the prompts.

Building

To create a production version of your app:

pnpm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.

Versioning

To create a new version run pnpm changeset version and follow the prompts.

Publishing

To publish a new version run pnpm changeset publish followed by git push --follow-tags. Assumes you have logged into NPM and have a git remote configured.

Deploying

To deploy your app to Vercel run pnpm deploy for testing or pnpm deploy -- --prod for production. Assumes you've signed-up for and logged into your Vercel account.