Armeria DocService client

A webapp that shows the Armeria Docs page.

Developing

To develop, start the dev server using

$ yarn
$ yarn run start

or with Gradle (NodeJS will be downloaded automatically)

$ ./gradlew :docs-client:yarn_run_start --no-daemon

This will usually not be useful since without a server running, the client does not have any spec it can render. You can have server calls proxied to a running Armeria server by specifying the ARMERIA_PORT environment variable, e.g.,

$ ARMERIA_PORT=51234 yarn run start

or with Gradle

$ ARMERIA_PORT=51234 ./gradlew :docs-client:yarn_run_start --no-daemon

Replacing the port of a docs page in the running server with 3000 will use the dev server to render while proxying all server calls to the actual Armeria server.

Updating licenses

When changing a dependency (i.e., when the yarn.lock file changes), refresh license information by running

$ yarn licenses generate-disclaimer --prod > ../licenses/web-licenses.txt