Svelte Typescript Boilerplate

This is a project template for Svelte apps.

Featuring

• Svelte
• Typescript
• Jest
• Svelte Testing Library
• Eslint
• Prettier
• Rollup
• i18n

For boilerplate with Tailwind support click here

Pre-requisite

• Install NodeJS 16.10+
• Install Yarn 1.2x

  npm install --global yarn
  

Get started

• Clone the Repo

  git clone https://github.com/wadehrarshpreet/svelte-typescript-boilerplace.git <project-name>
  

• go to project directoy and install dependencies

  cd <project-name> && yarn
  rm -rf .git # remove .git
  git init # setup new git repo
  

• Start dev server

  npm run dev
  

Navigate to localhost:8080. 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 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"

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

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

With firebase

Install firebase-cli if you haven't already:

curl -sL https://firebase.tools | bash

Login to your account

firebase login

Then, from within your project folder:

firebase init hosting # set public folder to deploy
npm run build
firebase deploy

Links

• https://wadehrarshpreet.com
• LinkedIn
• Twitter

License

MIT