Update the message in the popup we get when we login in the REPL

5 years ago · 211d86b4f8
parent 8839951185
commit 211d86b4f8
2 changed files with 13 additions and 8 deletions
--- a/site/README.md
+++ b/site/README.md
@ -17,13 +17,17 @@ By default, the REPL will fetch the most recent version of Svelte from https://u

 ## 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. Set its authorization callback URL to `http://localhost:3000/auth/callback`, and in this project, create `site/.env` containing:
-
-```
-GITHUB_CLIENT_ID=[your app's client id]
-GITHUB_CLIENT_SECRET=[your app's client secret]
-BASEURL=http://localhost:3000
-```
+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

--- a/site/src/server.js
+++ b/site/src/server.js
@ -82,11 +82,12 @@ if (process.env.GITHUB_CLIENT_ID) {
 		res.end(`
 			<body style="font-family: sans-serif; background: rgb(255,215,215); border: 2px solid red; margin: 0; padding: 1em;">
 				<h1>Missing .env file</h1>
-				<p>In order to use GitHub authentication, you will need to <a target="_blank" href="https://github.com/settings/developers">register an OAuth application</a> with <code>gist</code> and <code>read:user</code> scopes, and create a .env file:</p>
+				<p>In order to use GitHub authentication, you will need to <a target="_blank" href="https://github.com/settings/developers">register an OAuth application</a> and create a local .env file:</p>

 				<pre>GITHUB_CLIENT_ID=[YOUR_APP_ID]\nGITHUB_CLIENT_SECRET=[YOUR_APP_SECRET]\nBASEURL=http://localhost:3000</pre>

 				<p>The <code>BASEURL</code> variable should match the callback URL specified for your app.</p>
+				<p>See also <a target="_blank" href="https://github.com/sveltejs/svelte/tree/master/site#repl-github-integration">here</a></p>
 			</body>
 		`);
 	});