Skip to content

ctwhome/top-sveltekit

Repository files navigation

Top SvelteKit - Featured Packed Starter Template

The fastest and most comfortable development experience started template. Everything comes installed for a speedy start with examples. Simply remove what you don't need and you are good to go :)

With 🧡 from @ctwhome, feature-complete (WIP) according to @swyx.

Features

  • Latest SvelteKit
    • ESR, File-based routing, components auto importing, modules, etc.
    • TypeScript
    • Format on save with ESLint (VSCode Settings file and WebStorm)
    • Vite 3
  • PWA - vite-plugin-pwa
  • TailwindCSS 3 -
    • DaisyUI - Theme CSS components for TailwindCSS
    • Theme switcher - Custom theme and 22 themes to choose from.
  • Styled Markdown HTML components and page routing
    • Render Svelte Components and HTML from markdown
    • Route-based *.md pages
  • Unplugin Icons- All icons demand - +100.000 SVG icons completely customizable
  • SVG as a component (package)
  • Cloud functions with endpoints and *-adapter (Node, Vercel and Netlify)
  • i18n Multi-language support
  • Vitest (with JSDom and @testing-library/svelte)

BaaS (Backend-as-a-service)

  • Supabase (Auth, Realtime, Storage, and of course PostgreSQL)
  • Firebase
  • Appwrite

Feature examples

  • Markdown route based blog
  • Scrolly telling (@svelte/scrolling)
  • CRUD Todo
  • Consuming API

Extras

  • Native File API with IndexedDB persistance

  • Search Autocompete with defer

  • Feed RSS generator

Components

  • Date pickers
  • Infinite scroll (Virtual Scroll)
  • Tables
  • Modals
  • Simple gallery image
  • Tooltips / toasts
  • Draggable
  • Time series charts
  • Rich text (Copy and page images)
  • Autocomplete
  • Todo CRUD
  • Auth
  • Protected routes

Motivation and Personal Opinion

Svelte is the future, there is no other way. And having a clone-and-run repo with everything a basic web application needs is the best way to get started, spread the word, and create an even bigger ecosystem.

Installation and running locally

npx degit ctwhome/top-sveltekit <directory-name>
pnpm install

Updating fork

  1. Add remote from the original repository in your forked repository:
git remote add upstream git://github.com/ctwhome/top-sveltekit.git
git fetch upstream
  1. Updating your fork from the original repo to keep up with their changes: git pull upstream main

Start the development server on http://localhost:5137

pnpm dev

IDE

We recommend using VS Code with eslint and prettier (Tailwindcss plugging to organize the classes )

Recommended plugins popup

Production

Depending on the adaptor you choose, either SSR, SSG...etc

pnpm build