Skip to content

Update site README for local REPL #3078

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 23, 2019
Merged

Update site README for local REPL #3078

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a3560f
Update site README for local REPL
Rukenshia Jun 23, 2019
e7ac8be
Update README.md
Rich-Harris Jun 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions site/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ Set up the project:

```bash
git clone https://github.com/sveltejs/svelte.git
cd svelte/site
cd svelte
npm ci
PUBLISH=1 npm run build
cd site
npm ci
npm run update
```
Expand All @@ -17,7 +20,7 @@ By default, the REPL will fetch the most recent version of Svelte from https://u

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).
Then visit the REPL at [localhost:3000/repl?version=local](http://localhost:3000/repl?version=local). Please note that the local REPL only works with `npm run dev` and not when building the site for production usage.

## REPL GitHub integration

Expand All @@ -32,6 +35,13 @@ In order for the REPL's GitHub integration to work properly when running locally
GITHUB_CLIENT_SECRET=[your app's Client Secret]
BASEURL=http://localhost:3000
```
## Building the site

To build the website, run `npm run sapper`. The output can be found in `__sapper__/build`.

## Testing

Tests can be run using `npm run test`.

## Translating the API docs

Expand Down