README improvements and fixes #166
Conversation
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
✅ Deploy Preview for comforting-syrniki-15960f canceled.
|
| APOLLO_KEY={YOUR_API_KEY} npm run graphos-demo | ||
| ``` | ||
| ```sh | ||
| AUTH={YOUR_API_KEY} npm run graphos-demo |
There was a problem hiding this comment.
The scipts/demo.ts was looking for process.env.AUTH in line 16. So I changed this accordingly. Should we change the script instead?
|
|
||
| **\*Note**: We're currently working on subscriptions support with `rover dev` so the app is pointing at the deployed production url when running locally. You can change the URL the client application is pointing at by editing the `.env.development` file with `VITE_SERVER_HOST` set to the desired URL (most likely locally in the next steps) | ||
| Local subscriptions using `rover dev` is currently a work-in-progress, so features that use subscriptions are not functional (such as listening to playback state). You can change the URL the client application is pointing at by editing the `.env.development` file with `VITE_SERVER_HOST` and setting it to the production URL (uncomment the second line). |
There was a problem hiding this comment.
The instructions are actually downloading the router and running it. Do local subscriptions work that way? Should we remove this rover dev note?
| CALLBACK_URL=http://router:4000 | ||
| ``` | ||
| ``` | ||
| APOLLO_GRAPH_REF={YOUR_DEMO_GRAPH_ID}@main |
There was a problem hiding this comment.
I'm seeing main as the variant when I ran the script, not prod.
| ``` | ||
| npm run build | ||
| ``` | ||
|
|
||
| 5. In a new terminal, start the router: | ||
| ``` | ||
| npm run start:spotify && npm run start:playback | ||
| ``` | ||
|
|
||
| ``` | ||
| APOLLO_KEY={YOUR_DEMO_GRAPH_ID}@prod APOLLO_GRAPH_REF={YOUR_GRAPH_API_KEY} CALLBACK_URL=http://127.0.0.1:4000 npm run start:router | ||
| ``` | ||
| - Spotify Subgraph - http://localhost:4001 | ||
| - Playback Subgraph - http://localhost:4002 | ||
|
|
||
| > **Note:** If you make any edits to the subgraph files, you'll need to re-build and restart the subgraphs manually. If you're looking to do local development, you may want to navigate to each subgraph folder and run `npm run dev` instead, which will watch for changes and restart the subgraph automatically. |
There was a problem hiding this comment.
I had to build the subgraphs, otherwise the start commands wouldn't work.
|
|
||
| 5. Visit the website at http://localhost:3000 | ||
| By default, the client app is pointing to the _locally-running_ backend URL. Follow the section below for "I want to run the backend locally" (you can choose to use Docker, or not). |
There was a problem hiding this comment.
The original docs said it was pointing to the deployed prod URL, but that was actually untrue. Should we change it to point to the deployed prod? I changed the README to reflect the current state.
| @@ -1,5 +1,5 @@ | |||
| VITE_SERVER_HOST=http://localhost:4000 | |||
| # https://spotify-showcase-production-d157.up.railway.app/ | |||
| # VITE_SERVER_HOST=https://spotify-showcase-production-d157.up.railway.app/ # uncomment this to use the production URL | |||
There was a problem hiding this comment.
Making it clearer what this URL can be used for
As I was going through the instructions to get this running locally, I ran into a couple issues and realized the README was missing some steps or could use more clarity.