README.md

Radiant Portal

Radiant Data Platform

Backend

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Install swag

Before using make doc command:

go get github.com/swaggo/swag/v2@v2.0.0-rc4
go install github.com/swaggo/swag/v2/cmd/swag@v2.0.0-rc4

Create keycloak User

Realm settings are imported at start, still a user needs to be created manually in the UI http://localhost:8080.

Once created, assign the role api and a password incredentials tab.

MakeFile

Install all dependencies

make install

Run build make command with tests

make all

Build the application

make build

Run the application

make run

Create DB container

make docker-run

Shutdown DB Container

make docker-down

DB Integrations Test:

make itest

Live reload the application:

make watch

Run the test suite:

make test

Generate OpenAPI v3.1 documentation:

make doc

Clean up binary from the last build:

make clean

Frontend

Generate the CLI

```bash 

openapi-generator-cli generate -i ./backend/docs/swagger.yaml -g typescript-axios -o ./frontend/api

```