The frontend presents user-facing web pages on pkg.go.dev.
For additional information on functionality of the frontend, see the design document.
The main program lives in cmd/frontend. The bulk of the code lives in internal/frontend.
See experiment.md for instructions how to enable experiments.
You can run the frontend locally like so:
go run ./cmd/frontend [-dev] [-direct_proxy]
-dev flag reloads templates on each page load.The frontend can use one of three datasources:
The Datasource interface implementation is available at internal/datasource.go.
You can use the -direct_proxy flag to run the frontend with its datasource as the proxy service. This allows you to run the frontend without setting up a postgres database.
Alternatively, you can run pkg.go.dev with a local database. See instructions on how to set up and populate your local database with packages of your choice.
You can then run the frontend with: go run ./cmd/frontend
If you add, change or remove any inline scripts in templates, run devtools/cmd/csphash to update the hashes. Running all.bash will do that as well.
You can also use run the frontend locally with an in-memory datasource populated with modules loaded from your local filesystem.
go run ./cmd/pkgsite [path1,path2]
This allows you to run the frontend without setting up a database and to view documentation of local modules without requiring a proxy. The command accepts a list of comma-separated strings each representing a path of a module to load into memory.
In addition to tests inside internal/frontend and internal/testing/integration, pages on pkg.go.dev may have accessibility tree and image snapshot tests. These tests will create diffs for inspection on failure. Timeouts and diff thresholds are configurable for image snapshots if adjustments are needed to prevent test flakiness. See the API for jest image snapshots for more information.
To run the tests on your machine run ./all.bash e2e.
A migration to TypeScript for pkg.go.dev is underway. See #43359 for tracking info.
JavaScript assets for pkg.go.dev are built from TypeScript files in the content/static/js directory. All new scripts and updates to existing scripts should be written with TypeScript.
If you're modifying any TypeScript code, you must run ./all.bash npm run build for the changes to take effect. This script will require Docker to be installed.
To watch the source files for changes and have them rebuilt automatically you can run ./all.bash npm run develop.
You can test html and static asset changes by running ./all.bash npm test. This will run the TypeScript type checker and unit tests.
Lint your changes by running ./all.bash npm run lint. This will run stylelint and eslint on CSS and TS files in content/static. You can autofix some errors by running ./all.bash npm run lint -- --fix.