mhyfritz / svelte-tailwind-template

Svelte & Tailwind / Tailwind UI Template

Svelte & Tailwind CSS Template

This is a project template for Svelte and Tailwind CSS apps. It lives at https://github.com/mhyfritz/svelte-tailwind-template and is a fork from the official Svelte project template—kudos to the original authors!

What's inside

• Svelte v3 with a Rollup setup
  • svelte-preprocess setup to support @apply inside Svelte components
• Tailwind CSS v1.4
  • PostCSS setup with Autoprefixer
  • Purging of unused CSS
  • optional Tailwind UI setup that adds
    • @tailwindcss/ui plugin (and in extension @tailwindcss/custom-forms)
    • Inter font family

Installation

To create a new project based on this template using degit:

npx degit mhyfritz/svelte-tailwind-template svelte-tailwind-app

# for the Tailwind UI setup:
# npx degit mhyfritz/svelte-tailwind-template#tailwind-ui svelte-tailwind-app

cd svelte-tailwind-app

Note that you will need to have Node.js installed.

Get started

Install the dependencies...

cd svelte-tailwind-app
npm install

...then start Rollup:

npm run dev

Navigate to localhost:5000. You should see your app running. Edit a component file in src, save it, and reload the page to see your changes.

By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the sirv commands in package.json to include the option --host 0.0.0.0.

Building and running in production mode

To create an optimised version of the app:

npm run build

You can run the newly built app with npm run start. This uses sirv, which is included in your package.json's dependencies so that the app will work when you deploy to platforms like Heroku.

Single-page app mode

By default, sirv will only respond to requests that match files in public. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere.

If you're building a single-page app (SPA) with multiple routes, sirv needs to be able to respond to requests for any path. You can make it so by editing the "start" command in package.json:

"start": "sirv public --single"

Deploying to the web

With Vercel

Install vercel if you haven't already:

npm install -g vercel

Then, from within your project folder:

cd public
vercel deploy --name my-project

With surge

Install surge if you haven't already:

npm install -g surge

Then, from within your project folder:

npm run build
surge public my-project.surge.sh