felt-template

a static web app and Node library template with Svelte, SvelteKit, felt-ui, and Gro

deployed: template.felt.dev

contents

• SvelteKit with Svelte and Vite
• Gro:
  • extends SvelteKit and Vite
  • integrated TypeScript with Svelte and svelte-check
  • testing with uvu
  • formatting with Prettier
  • linting with ESLint and @feltjs/eslint-config
  • also has a task system with a bunch of builtins, codegen, and other things
• felt-ui:
  • a package with Svelte UI components and styles
  • optional utilities library
  • docs and more at felt.dev
  • to remove it, npm uninstall @feltjs/felt-ui and delete the imports

usage

This project uses SvelteKit with the static adapter and Vite, so the normal commands like vite dev work as expected. It also uses gro for additional things like deploying - see below for more.

Windows is not yet supported (we recommend WSL)

If you're logged into GitHub, click "Use this template" above or clone with degit:

npx degit feltjs/felt-template cooltoy
cd cooltoy
npm i
# then
vite dev
# or
gro dev # npm i -g @feltjs/gro
# or
npm run dev

learn more about SvelteKit, Vite, Gro, and felt-ui

The template includes @sveltejs/adapter-static so it can deploy with no further configuration. To learn how to swap it out for another deployment target, see the SvelteKit adapter docs.

To make it your own, change felt-template and template.felt.dev to your project name in the following files:

• package.json
• svelte.config.js
• src/routes/+layout.svelte
• src/routes/+page.svelte
• update or delete src/static/CNAME

Then run npm i to update package-lock.json.

Optionally add a license file and package.json value, like "license": "MIT".

build

npm run build
# or
gro build

See Gro's build docs for more.

test

gro test
gro test filepattern1 filepatternB
gro test -- uvu --forwarded_args 'to uvu'

See uvu, src/lib/example.test.ts, and Gro's test docs for more.

deploy

Deploy (build, commit, and push) to the deploy branch, e.g. for GitHub Pages:

npm run deploy
# or
gro deploy

credits 🐢_🐢🐢

Svelte ∙ SvelteKit ∙ Vite ∙ esbuild ∙ uvu ∙ TypeScript ∙ ESLint ∙ Prettier ∙ felt-ui ∙ @feltjs/util ∙ Gro & more

🐦