Looking for a shareable component template? Go here --> sveltejs/component-template
npx degit sveltejs/template showcase
cd showcase
npm i --save-dev svelte-preprocess
npm i --save-dev postcss-utilities @fullhuman/postcss-purgecss autoprefixer postcss postcss-cli postcss-import@12 postcss-nesting
npm i --save-dev tailwindcss
npx tailwindcss init
npm i --save-dev rollup-plugin-postcss
- Change the rollup config
import postcss from 'rollup-plugin-postcss'
import autoPreprocess from 'svelte-preprocess'
svelte({
preprocess: autoPreprocess({
// https://github.com/kaisermann/svelte-preprocess/#user-content-options
sourceMap: !production,
postcss: {
plugins: [
require('tailwindcss'),
require('autoprefixer'),
require('postcss-nested'),
],
},
}),
// enable run-time checks when not in production
dev: !production,
// we'll extract any component CSS out into
// a separate file - better for performance
css: (css) => {
css.write('bundle.css')
},
}),
postcss({
extract: 'public/utils.css',
}),
- create a file src/Tailwind.svelte
<style global lang="postcss">
/* only apply purgecss on utilities, per Tailwind docs */ /* purgecss start
ignore */ @tailwind base; @tailwind components; /* purgecss end ignore */
@tailwind utilities;
</style>
- modify App.svelte
<script>
import Tailwind from "./Tailwind.svelte";
export let name;
</script>
<style lang="postcss">
main {
text-align: center;
padding: 1em;
max-width: 240px;
margin: 0 auto;
}
h1 {
color: #ff3e00;
text-transform: uppercase;
font-size: 4em;
font-weight: 100;
}
@media (min-width: 640px) {
main {
max-width: none;
.tw {
@apply font-sans text-lg text-center text-green-800;
}
}
}
</style>
<Tailwind />
<main>
<h1>Hello {name}!</h1>
<p class="tw">tailwind included<span class="text-red-800">!</span></p>
<p>
Visit the
<a href="https://svelte.dev/tutorial">Svelte tutorial</a>
to learn how to build Svelte apps.
</p>
</main>
- run cli
npx -p @storybook/cli sb init --type svelte --use-npm
- add postcss to .storybook/main.js
const sveltePreprocess = require('svelte-preprocess')
module.exports = {
stories: ['../src/**/*.stories.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)'],
addons: ['@storybook/addon-links', '@storybook/addon-essentials'],
webpackFinal: async (config) => {
const svelteLoader = config.module.rules.find(
(r) => r.loader && r.loader.includes('svelte-loader'),
)
svelteLoader.options = {
...svelteLoader.options,
preprocess: sveltePreprocess({
postcss: {
plugins: [
require('tailwindcss'),
require('autoprefixer'),
require('postcss-nested'),
],
},
}),
}
return config
},
}
- preload tailwindcss in preview-head.html
<link
rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/tailwindcss/1.9.6/tailwind.min.css"
integrity="sha512-l7qZAq1JcXdHei6h2z8h8sMe3NbMrmowhOl+QkP3UhifPpCW2MC4M0i26Y8wYpbz1xD9t61MLT9L1N773dzlOA=="
crossorigin="anonymous"
/>
npm i chokidar cross-env electron npm-run-all --save-dev
- add electron.js, modify package.json
- relativise pathes in public/index.html
<link rel='stylesheet' href='build/bundle.css'>
<script defer src="build/bundle.js"></script>
This is a project template for Svelte apps. It lives at https://github.com/sveltejs/template.
To create a new project based on this template using degit:
npx degit sveltejs/template svelte-app
cd svelte-app
Note that you will need to have Node.js installed.
Install the dependencies...
cd svelte-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
.
If you're using Visual Studio Code we recommend installing the official extension Svelte for VS Code. If you are using other editors you may need to install a plugin in order to get syntax highlighting and intellisense.
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.
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"
This template comes with a script to set up a TypeScript development environment, you can run it immediately after cloning the template with:
node scripts/setupTypeScript.js
Or remove the script via:
rm scripts/setupTypeScript.js
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