Skip to content

Commit

Permalink
chore: update backend README (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
richardtreier authored Mar 7, 2024
1 parent 87ffe25 commit e01e0af
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion authority-portal-backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Backend + Frontend + E2E Tests

## About This Component

Backend code for ... TODO
Backend for the Authority Portal. Built with Quarkus, Kotlin and JOOQ.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand Down Expand Up @@ -60,6 +60,8 @@ One might argue all the these types of tests to be unit tests:
- Unit test don't work well when the unit under test contains db concerns.
For testing code that uses JooQ Integration Tests are recommended.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

### Local E2E Development

To start the backend in development mode, a JDK17 and docker are required.
Expand All @@ -70,6 +72,8 @@ To start the backend in development mode, a JDK17 and docker are required.

> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/
<p align="right">(<a href="#readme-top">back to top</a>)</p>

#### Local E2E Development: Basic Auth

To simplify local development there are dev users available, see:
Expand All @@ -79,6 +83,8 @@ To simplify local development there are dev users available, see:
- Contains the test users.
- Roles come from the `application.properties`, though.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

### Keycloak

Local development uses a Keycloak instance launched by Quarkus Dev Services both for authentication and manual testing
Expand Down

0 comments on commit e01e0af

Please sign in to comment.