kit Documentation

1. Project Overview & Quickstart (sveltejs/kit) Copy Chapter

File: README.md Copy Chapter

SvelteKit

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

Packages Copy Section

Additional adapters are maintained by the community.

Bug reporting Copy Chapter

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 Copy Chapter

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

Supporting Svelte Copy Chapter

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:

• Becoming a backer on Open Collective.

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 Copy Chapter

MIT

File: documentation/docs/98-reference/[email protected] Copy Chapter

title: @sveltejs/kit Copy Chapter

MODULE: @sveltejs/kit

Private types Copy Chapter

The following are referenced by the public types documented above, but cannot be imported directly:

TYPES: Private types {depth=3}

File: documentation/docs/98-reference/[email protected] Copy Chapter

title: @sveltejs/kit/node/polyfills Copy Chapter

MODULE: @sveltejs/kit/node/polyfills

2. Official Technical Reference & Guides (sveltejs/sveltejs.github.io) Copy Chapter

[v2.svelte.dev](https://v2.svelte.dev)

The website for Svelte v2.

Note Copy Chapter

This is the repo for the Svelte v2 site. The Svelte v3 site lives in the site directory of the main Svelte repo.

Running locally Copy Chapter

This project uses yarn to manage dependencies.

Set up the project:

git clone [email protected]:sveltejs/v2.svelte.dev.git
cd v2.svelte.dev
yarn

Start the server with yarn run dev, and navigate to localhost:3000.

Using a local copy of Svelte Copy Chapter

By default, the REPL will fetch the most recent version of Svelte from https://unpkg.com/svelte. If you need to test a local version of Svelte, you can do so by linking it and navigating to localhost:3000/repl?version=local:

cd /path/to/svelte
yarn link
yarn dev # rebuild Svelte on changes

cd /path/to/v2.svelte.dev
yarn link svelte
yarn dev

REPL GitHub integration Copy Chapter

In order for the REPL's GitHub integration to work properly when running locally, you will need to create a GitHub OAuth app. Set its authorization callback URL to http://localhost:3000/auth/callback, and in the root of this project, create a file .env containing:

GITHUB_CLIENT_ID=[your app's client id]
GITHUB_CLIENT_SECRET=[your app's client secret]
BASEURL=http://localhost:3000

License Copy Chapter

MIT