Svelte SPA Template
A Svelte Single Page Application Template for simple SPA Apps without using Svelte Kit or Sapper.
New Project
To create a new project based on this template using degit:
npx degit DEVLOPRR/svelte-spa-template svelte-spa-app
cd svelte-spa-app
Note that you will need to have Node.js installed.
Get started
Install the dependencies...
cd svelte-spa-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.
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 devDependencies
so that the app will work when you deploy to platforms like Heroku.
Using TypeScript
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
If you want to use baseUrl
or path
aliases within your tsconfig
, you need to set up @rollup/plugin-alias
to tell Rollup to resolve the aliases. For more info, see this StackOverflow question.
Deploying to the web
Vercel
WithInstall vercel
if you haven't already:
npm install -g vercel
Then, from within your project folder:
cd public
vercel deploy --name my-project
surge
WithInstall 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
GitHub Pages
WithMake sure you have a github account and you've logged into the account.
Then make a New github repo and name it as follows - username.github.io
where username is your github username you're using and make sure your repo is public.
Finally, Upload your build files and after a minute goto username.github.io
where username is your github username.