artin/sourcegraph
1
0
Fork 0
mirror of https://github.com/sourcegraph/sourcegraph.git synced 2026-02-06 17:11:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
0fd7e9e1da
sourcegraph/client/web
History
James McNamara 0fd7e9e1da
REALLY ready really means REALLY ready (#60652) 
* Added a ping before displaying banner

* added comment about NODE_TLS

* updated typing imports
2024-02-21 12:10:24 -08:00
..
__mocks__ reapply "switch from jest to vitest for faster, simpler tests (#57886)" (#58145) 2023-11-07 12:00:18 +02:00
bookmarklet
dev REALLY ready really means REALLY ready (#60652) 2024-02-21 12:10:24 -08:00
dist svelte: Update messaging and icon for switching to/from the prototype (#60049) 2024-02-02 15:07:40 +01:00
src Replace /get-cody links with /cody/manage (#60636) 2024-02-21 07:42:51 -08:00
.bazelignore bazel: ignore files generated into src (#45922) 2022-12-21 20:43:29 -08:00
.eslintignore
.stylelintrc.json search: remove onboarding tour (#38142) 2022-07-06 13:22:27 +02:00
BUILD.bazel site admin: add link to Cody Analytics (#60371) 2024-02-09 17:08:15 +00:00
bundlesize.config.js Revert "use vite for web builds (#58228)" (#59132) 2023-12-20 16:23:45 -03:00
package.json Clean dist directory on build (#60629) 2024-02-20 10:26:52 -08:00
README.md Docs: update links to point to new site (#60381) 2024-02-13 00:23:47 +00:00
statoscope Report bundle size diff in PRs (#42277) 2022-10-12 10:19:51 +02:00
tsconfig.json Revert "use vite for web builds (#58228)" (#59132) 2023-12-20 16:23:45 -03:00
vitest.config.ts bazel: fix vitest_test in Bazel in sandbox mode (#58274) 2023-11-15 10:14:41 +01:00

README.md

Web Application

Local development

Use sg CLI tool to configure and start local development server. For more information check out the sg documentation.

Our local development server runs by starting both a Caddy HTTPS server and a Node HTTP server. We then can reverse proxy requests to the Node server to serve client assets under HTTPS.

Configuration

Environment variables important for the web server:

  1. WEB_BUILDER_SERVE_INDEX should be set to true to enable serving of an index page.
  2. SOURCEGRAPH_API_URL is used as a proxied API url. By default it points to the https://k8s.sgdev.org.

It's possible to overwrite these variables by creating sg.config.overwrite.yaml in the root folder and adjusting the env section of the relevant command.

Development server

sg start web-standalone

Public API

To use a public API that doesn't require authentication for most of the functionality:

SOURCEGRAPH_API_URL=https://sourcegraph.com sg start web-standalone

Production server

sg start web-standalone-prod

Web app should be available at https://${SOURCEGRAPH_HTTPS_DOMAIN}:${SOURCEGRAPH_HTTPS_PORT}. Build artifacts will be served from <rootRepoPath>/client/web/dist.

Note: If you are unable to use the above commands (e.g. you can't install Caddy), you can use sg run web-standalone-http instead. This will start a development server using only Node, and will be available at http://localhost:${SOURCEGRAPH_HTTP_PORT}.

API proxy

In both environments, server proxies API requests to SOURCEGRAPH_API_URL provided as the .env variable.