mirror of https://github.com/sveltejs/svelte
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
41 lines
1.8 KiB
41 lines
1.8 KiB
## Running locally
|
|
|
|
Set up the project:
|
|
|
|
```bash
|
|
git clone https://github.com/sveltejs/svelte.git
|
|
cd svelte/site
|
|
npm ci
|
|
npm run update
|
|
```
|
|
|
|
Start the server with `npm run dev`, and navigate to [localhost:3000](http://localhost:3000).
|
|
|
|
## Using a local copy of Svelte
|
|
|
|
By default, the REPL will fetch the most recent version of Svelte from https://unpkg.com/svelte. When running the site locally, you can also use your local copy of Svelte.
|
|
|
|
To produce the proper browser-compatible UMD build of the compiler, you will need to run `npm run build` (or `npm run dev`) in the root of this repository with the `PUBLISH` environment variable set to any non-empty string.
|
|
|
|
Then visit the REPL at [localhost:3000/repl?version=local](http://localhost:3000/repl?version=local).
|
|
|
|
## REPL GitHub integration
|
|
|
|
In order for the REPL's GitHub integration to work properly when running locally, you will need to:
|
|
- [create a GitHub OAuth app](https://github.com/settings/developers):
|
|
- set `Authorization callback URL` to `http://localhost:3000/auth/callback`;
|
|
- set `Application name` as you like, and `Homepage URL` as `http://localhost:3000/`;
|
|
- create the app and take note of `Client ID` and `Client Secret`
|
|
- in this repo, create `site/.env` containing:
|
|
```
|
|
GITHUB_CLIENT_ID=[your app's Client ID]
|
|
GITHUB_CLIENT_SECRET=[your app's Client Secret]
|
|
BASEURL=http://localhost:3000
|
|
```
|
|
|
|
## Translating the API docs
|
|
|
|
Anchors are automatically generated using headings in the documentation and by default (for the english language) they are latinised to make sure the URL is always conforming to RFC3986.
|
|
|
|
If we need to translate the API documentation to a language using unicode chars, we can setup this app to export the correct anchors by setting up `SLUG_PRESERVE_UNICODE` to `true` in `config.js`.
|