From 7cbb6a8b09569a6bdaffb3d1a453c3b30d40700b Mon Sep 17 00:00:00 2001 From: Michael Thomas <66232628+MichaelThomas0721@users.noreply.github.com> Date: Thu, 13 Jul 2023 17:17:25 -0400 Subject: [PATCH] Add Svelte to guide (#6269) Added a guide on proxying to a Svelte app since there wasn't one already. Used the vue and angular guides as a template and included a link to an issue post on sveltekits website which adds some context. --- docs/guide.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/guide.md b/docs/guide.md index 019c619bd..712a465a7 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -19,6 +19,7 @@ - [Proxying to create a React app](#proxying-to-create-a-react-app) - [Proxying to a Vue app](#proxying-to-a-vue-app) - [Proxying to an Angular app](#proxying-to-an-angular-app) + - [Proxying to a Svelte app](#proxying-to-a-svelte-app) - [SSH into code-server on VS Code](#ssh-into-code-server-on-vs-code) - [Option 1: cloudflared tunnel](#option-1-cloudflared-tunnel) - [Option 2: ngrok tunnel](#option-2-ngrok-tunnel) @@ -414,6 +415,27 @@ In order to use code-server's built-in proxy with Angular, you need to make the For additional context, see [this GitHub Discussion](https://github.com/coder/code-server/discussions/5439#discussioncomment-3371983). +### Proxying to a Svelte app + +In order to use code-server's built-in proxy with Svelte, you need to make the following changes in your app: + +1. Add `svelte.config.js` if you don't already have one +2. Update the values to match this (you can use any free port): + +```js +const config = { + kit: { + paths: { + base: "/absproxy/5173", + }, + }, +} +``` + +3. Access app at `/absproxy/5173/` e.g. `http://localhost:8080/absproxy/5173/ + +For additional context, see [this Github Issue](https://github.com/sveltejs/kit/issues/2958) + ## SSH into code-server on VS Code [![SSH](https://img.shields.io/badge/SSH-363636?style=for-the-badge&logo=GNU+Bash&logoColor=ffffff)](https://ohmyz.sh/) [![Terminal](https://img.shields.io/badge/Terminal-2E2E2E?style=for-the-badge&logo=Windows+Terminal&logoColor=ffffff)](https://img.shields.io/badge/Terminal-2E2E2E?style=for-the-badge&logo=Windows+Terminal&logoColor=ffffff) [![Visual Studio Code](https://img.shields.io/badge/Visual_Studio_Code-007ACC?style=for-the-badge&logo=Visual+Studio+Code&logoColor=ffffff)](vscode:extension/ms-vscode-remote.remote-ssh)