kit README

The project's README from github.com/sveltejs/kit. As one markdown file: README.md.

Chat

SvelteKit

Web development, streamlined. Read the documentation to get started.

Packages

Package Changelog
@sveltejs/kit Changelog
@sveltejs/adapter-auto Changelog
@sveltejs/adapter-cloudflare Changelog
@sveltejs/adapter-netlify Changelog
@sveltejs/adapter-node Changelog
@sveltejs/adapter-static Changelog
@sveltejs/adapter-vercel Changelog
@sveltejs/enhanced-img Changelog
@sveltejs/package Changelog

Additional adapters are maintained by the community.

Bug reporting

Please make sure the issue you're reporting involves SvelteKit. Many issues related to how a project builds originate from Vite, which is used to build a SvelteKit project. You can create a new Vite project with npm create vite@latest for client-side only repros and npm create vite-extra@latest for SSR or library repros.

If an issue originates from Vite, please report it in the Vite issue tracker.

Contributing

See CONTRIBUTING.md for information on how to develop SvelteKit locally.

Supporting Svelte

Svelte is an MIT-licensed open source project with its ongoing development made possible entirely by fantastic volunteers. If you'd like to support their efforts, please consider:

Funds donated via Open Collective will be used for compensating expenses related to Svelte's development such as hosting costs. If sufficient donations are received, funds may also be used to support Svelte's development more directly.

License

MIT

kit (sveltejs/kit)

full-stack
Searching Database…

20.9K ·GitHub
What is this?SvelteKit is the official framework for building web apps with Svelte — you write Svelte components and SvelteKit streamlines the rest, building your project through Vite.
So is it a library or a full framework?A framework: the core @sveltejs/kit package ships alongside a family of official adapters, and Vite is the underlying build tool, so it orchestrates whole apps rather than just UI components.
How do I actually start building with it?The README points straight to the official documentation; from there you scaffold a project and develop and build it through Vite like any modern JavaScript app.
What do I need installed to work with it?The Node.js toolchain: the README's own examples create projects with npm create commands, so you will be working in the standard Node and npm ecosystem.
Does it require a running server, or can I ship a static site too?A server is optional: official adapters include adapter-static for fully prerendered sites as well as adapter-node for traditional server deployments.
Where can I deploy a SvelteKit app?First-party adapters target Cloudflare, Netlify, Node, static hosting and Vercel, with adapter-auto as the default pick; additional adapters are community-maintained.
Is it really free, or is there a paid tier?Completely free: a volunteer-run open-source project, with optional donations on Open Collective that cover expenses like hosting and, if funds allow, support development directly.
What's under the hood of a SvelteKit app?Vite — SvelteKit uses it as its build tool, and the README even has you reproduce build problems in a bare Vite project, since many issues originate there rather than in SvelteKit itself.
What else comes out of this repo besides the core framework?Official adapter packages for auto, Cloudflare, Netlify, Node, static and Vercel deployments, plus @sveltejs/enhanced-img and @sveltejs/package, all managed as one pnpm monorepo.
What are similar projects?graphql, next.js, astro, nuxt, framework, gatsby, fresh, razzle
Creator
sveltejs
Size
44.4 MB
Stars
20.9K
Age
6y
Commits · 90 Days