Update site README for local REPL (#3078)

* Update site README for local REPL

* Change the local install instructions to be able to use the local repl out of the box
This avoids potential confusion in setting the website up for local use.

* Add sections for Testing and Building
* Add a note that the local REPL will only work for the development page

* Update README.md
pull/3093/head
Jan C 6 years ago committed by Rich Harris
parent 886fb66b41
commit 9bf8fd3747

@ -4,7 +4,10 @@ Set up the project:
```bash ```bash
git clone https://github.com/sveltejs/svelte.git 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 ci
npm run update npm run update
``` ```
@ -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. 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 ## REPL GitHub integration
@ -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] GITHUB_CLIENT_SECRET=[your app's Client Secret]
BASEURL=http://localhost:3000 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 ## Translating the API docs

Loading…
Cancel
Save