Gotify

Appearance

Servers and Tests ​

Start development servers ​

Backend ​

The backend needs a built ui. Run

bash
$ (cd ui && yarn build)

Start the server in development mode.

bash
$ go run .

UI ​

Start the UI development server.

Commands must be executed inside the ui directory.

bash
$ yarn start

Open http://localhost:3000 inside your favorite browser.

The UI requires a Gotify server running on localhost:80. This can be adjusted inside ui/src/index.tsx.

Update Swagger spec ​

The gotify/server REST-API is documented via Swagger. The Swagger definition is generated via source code comments (example comment).

After changing such a source code comment, you can run the following command to update the Swagger definition.

bash
$ make update-swagger

Tests ​

Execute Backend Tests ​

Run tests with parallelism ​

bash
$ go test ./...

Run Tests with Coverage ​

bash
$ make test-coverage
$ go tool cover -html=coverage.txt # get a HTML coverage report

Run Tests with Race Detector ​

bash
$ make test-race

Execute UI (end2end) Tests ​

Build the ui because the end2end test should be run against the production build. (This needs to be done on every change in the UI)

bash
$ (cd ui && yarn build)

Now execute the tests with yarn

bash
$ (cd ui && yarn test)

Execute Static Checks ​

The following command checks the formatting and executes some linters like tslint and govet.

bash
$ make check