Overview
Svelte Starter Kit is a boilerplate based on SvelteKit, designed to provide all the necessary features and tools for starting a Full-stack Svelte/Javascript project. It includes features such as Typescript as the language choice, Tailwind CSS for styling, ESLint and Prettier for code analysis and formatting, pre-configured SEO settings, and Supabase as the 3rd Party Persistence Layer for authentication system and user profiles. Additionally, it offers a variety of pre-made components, including Alert/Toast for notifications, Modal and Sidepanel support, Loaders for progress reporting, Popover for contextual menus, and Form Helpers for input types, validation, and submission.
Features
- Typescript: Svelte Starter Kit supports Typescript as the language choice.
- Tailwind CSS: Quick styling without getting out of HTML using Tailwind CSS.
- ESLint and Prettier: Static code analysis and code formatting tools.
- SEO pre-configured: Pre-configured SEO settings for better search engine optimization.
- Supabase Authentication System: Integration with Supabase for authentication system.
- User Profiles: User profiles available as an example, utilizing Supabase PostgREST (CRUD API).
- User Avatar: Support for user avatars using Supbase Storage (AWS S3 backed effortless uploads).
- Pre-made Components: A collection of pre-made components for non-trivial projects, including Alert/Toast, Modal, Loaders, Popover, and Form Helpers.
Installation
To set up Svelte Starter Kit, follow these steps:
- Create an account at Supabase.
- Create an organization and a project within Supabase.
- Once the project is generated, copy the API authentication details from the project’s settings page.
- Place the copied details in the
.envor.env.localfile asVITE_SUPABASE_URLandVITE_SUPABASE_ANON_KEY. - Install the necessary NPM dependencies.
- If you want to enable profile and user avatars, execute the provided SQL query at the Supabase project’s SQL editor.
- Start the project by running
yarn dev.
Summary
Svelte Starter Kit is a comprehensive boilerplate for starting Full-stack Svelte/Javascript projects. It provides essential features such as Typescript support, Tailwind CSS for easy styling, ESLint and Prettier for code analysis and formatting, pre-configured SEO settings, and integration with Supabase for authentication system and user profiles. The kit also includes a wide range of pre-made components for common functionalities. Setting up the kit involves creating a Supabase account, generating an API key, and installing the required NPM dependencies. With Svelte Starter Kit, developers can quickly start building Svelte-based applications with all the necessary tools and features readily available.