Skip to content

Commit

Permalink
Merge pull request #441 from yetanalytics/dev-checklist
Browse files Browse the repository at this point in the history
Development checklist
  • Loading branch information
kelvinqian00 authored Jan 14, 2025
2 parents a20e679 + 1dbe44a commit 5dde8e7
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@

The SQL LRS is a Clojure Web Application built on the Pedestal Framework.

### Testing

Development is primarily test-driven, which uses an exhaustive suite of unit tests. To run them locally, run a `make test-[database]` command. In addition, all tests are run for all versions in GitHub Actions CI.

However, in some situations, such as UI development, relying on the unit tests may be inadequate. In these cases, in addition to performing visual tests on the UI, one may need to test these specific scenarios:
- Login with OIDC ([demo](oidc.md#keycloak-demo))
- Proxy paths ([demo](other_demos.md#proxied-lrs-demo))
- JWT override ([JWT config vars](env_vars.md#jwt-config))

### Build

The SQL LRS can be built or run with the following Makefile targets. They can be executed with `make [target]`.
Expand Down

0 comments on commit 5dde8e7

Please sign in to comment.