Raid Registration Agency
Table of Contents
- Getting Started
- Installation
- Running the Application
- Running E2E Tests
- Project Structure
- API Documentation
- Contributing
- License
Getting Started
To get started you'll need the following tools installed in your machine:
- Node.js >= 22
- Java >= 17
- Docker >= 27
Installation
- Clone the repository
git clone https://github.com/au-research/raid-au.git
- Build the API
cd raid-au
./gradlew build
- Install dependencies for the app
cd raid-agency-app
npm install
Running the Application
- Start the local dev stack (Docker services + API)
./gradlew bootRunLocal
This starts PostgreSQL, Keycloak, and MockServer via Docker Compose, then launches the Spring Boot API with the dev profile. The API runs on http://localhost:8080.
- Start the frontend (in a separate terminal)
cd raid-agency-app
npm run dev
The app runs on http://localhost:7080.
Running E2E Tests
End-to-end tests use Playwright and require the local dev stack to be running.
- Start the local dev stack (if not already running)
./gradlew bootRunLocal
- Run the tests (in a separate terminal)
cd raid-agency-app
npx playwright test
Project Structure
| |
|---|
api-svc/db | The database migrations (handled by flyway) and generated database classes (handled by JOOQ) |
api-svc/idl-raid-v2 | OpenApi specs and code generation for API controllers |
api-svc/raid-api | API Spring Boot application |
iam/realms | Keycloak configuration used in local environment/integration tests. Loaded at startup |
iam/src | Keycloak SPIs to handle group/raid permissions. |
sso/ | Docker config for Satosa. This allows SAML authentication between AAF and Keycloak for eduGAIN |
API Documentation
Contributing
We welcome contributions from the community! Whether you're fixing bugs, adding new features, improving documentation, or suggesting ideas, we'd love to have your input. Feel free to raise a pull request (include tests).
License
This project is licensed under the Apache 2.0 License - see the license.txt file for details.
