search

compliance-framework / portal

The web application that houses all the dashboards and management-related tasks.
2 stars 1 forks source link

readme

Compliance Framework UI

Main

Quickstart

  1. Make sure pnpm is installed npm i -g pnpm
  2. cd to project
  3. Install dependencies pnpm i
  4. Make sure the configuration service is running.
  5. Run dev command pnpm dev
  6. It will show you what to open in terminal.

Deployment

There is a Dockerfile available that runs on port 8081 that has it's own minimal and fast HTTP server written using labstack echo.

Looking through the Dockerfile would be the best place to look with regards to how it is built, if you wish to for instance build/deploy onto your own CDN instead of running as a container.

Services

Services should be auto-generated from locally running swagger using pnpm gen

Do not update (will be overwritten):

Config

Configuration is done via vite env variables. See here for how these work.