1
0
mirror of https://github.com/google/nomulus synced 2026-06-09 16:33:02 +00:00
Files
nomulus/docs/local-testing.md
T
Ben McIlwain dcfe939c38 Update docs for Java 25 and GKE migration (#3089)
Summarize all documentation updates across the repository to align with modern GKE, Cloud SQL Proxy v2, standard EPP fee v1.0, and Postgres database environments.

Key Updates:
- Prerequisites: Bump Java requirement to Java 25.
- Architecture & Scaling: Document GKE workloads, Cloud Tasks queues, and scheduled tasks. Replace App Engine references with GKE deployment restart commands (kubectl rollout restart).
- Configuration: Update Cloud SQL Proxy instructions to v2, fix keyring verification commands, and document IAP configuration.
- Escrow (RDE/BRDA): Fix manual generation and download procedures to match the Dataflow job ID folder structure, and correct deposit encryption/verification command parameters.
- Monitoring: Correct metric names and expand the documented metrics list with caching, locking, and reserved list metrics.
- Fixes: Standardize lists formatting across markdown files, fix broken webdriver links, and resolve various typos.
- Cleanup: Remove leftover cloud scheduler configurations for the deleted wipeOutContactHistoryPii task, and update ICANN reporting documentation to reflect open-sourced DNS query coordinator.

TAG=agy
CONV=88271e71-e272-40e0-85f8-a075a423b7c2
2026-06-22 18:20:00 +00:00

1.4 KiB

Local Testing

Running a local development server

Nomulus provides a RegistryTestServer that is a lightweight test server suitable for running local development. It uses local versions of all Google Cloud Platform dependencies when available. Correspondingly, it is primarily useful for doing web UI development (i.e. the registrar console). It allows you to update Typescript, HTML, and CSS and see the changes simply by refreshing the relevant page in your browser.

In order to serve content locally, there are two services that must be run:

  • The RegistryTestServer to serve as the backing server.
  • The Angular service to provide the UI files.

In order to do this in one step, from the console-webapp folder, run:

$ npm install
$ npm run start:dev

This will start both the RegistryTestServer and the Angular testing service. Any changes to Typescript/HTML/CSS files will be recompiled and available on page reload.

Once it is running, you can interact with the console by going to http://localhost:4200 to view the registrar console in a web browser. The server will continue running until you terminate the process.

If you are adding new URL paths, or new directories of web-accessible resources, you will need to make the corresponding changes in RegistryTestServer. This class contains all the routing and static file information used by the local development server.