1
0
mirror of https://github.com/google/nomulus synced 2026-04-28 20:07:28 +00:00

Reformat, rearrange, and edit install guide

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=135124027
This commit is contained in:
mcilwain
2016-10-04 10:40:29 -07:00
committed by Ben McIlwain
parent 071de78a6d
commit e0f2620333
2 changed files with 239 additions and 157 deletions

View File

@@ -1,4 +1,37 @@
# Developing
Advice on how to do development on the Domain Registry codebase, including how
to set up an IDE environment and run tests.
This document contains advice on how to do development on the Nomulus codebase,
including how to set up an IDE environment and run tests.
## Running a local development server
`RegistryTestServer` is a lightweight test server for the registry that is
suitable for running locally for development. It uses local versions of all
Google Cloud Platform dependencies, when available. Correspondingly, its
functionality is limited compared to a Domain Registry instance running on an
actual App Engine instance. It is most helpful for doing web UI development such
as on the registrar console: it allows you to update JS, CSS, images, and other
front-end resources, and see the changes instantly simply by refreshing the
relevant page in your browser.
To see the registry server's command-line parameters, run:
```shell
$ bazel run //javatests/google/registry/server -- --help
```
To start an instance of the server, run:
```shell
$ bazel run //javatests/google/registry/server {your params}
```
Once it is running, you can interact with it via normal `nomulus` commands, or
view the registrar console in a web browser by navigating to
[http://localhost:8080/registrar](http://localhost:8080/registrar). 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 of the routing and static file information used by the local
development server.