Development

Requirements

Ensure that the following tools are installed:

Go 1.18 (install instructions)
Node 16.x.x (install instructions)
GoReleaser (install instructions)

Run the following commands after a fresh clone:

make install-tools (installs development tools)
make init-server (initializes the server config)

Local Build

To run a local build:

Run make dev
Navigate to http://localhost:3000

Testing

The following commands are used to run tests:

make test (runs server tests)
make ui-test (runs ui tests)

Other Commands

make build (creates a build of bindplane-op)
make swagger (creates REST API swagger documentation)
make generate (generates the graphql server)
make help (lists make targets with descriptions)