The following diagram lays out the high-level architecture of CI Dashboard and its component packages:
graph TB
umb-listener --> bus[Message bus]:::outside
subgraph kaijs
umb-listener[UMB listener] --> queue[Filesystem queue]
fedmsg-listener[fedmsg listener] --> queue
Loader --> queue
end
Loader --> db[Opensearch]
server["ciboard-server<br>(backend)"] --> db
ciboard["ciboard<br>(frontend)"]:::focus --> server
click ciboard "https://github.com/fedora-ci/ciboard/" "ciboard GitHub repositotry" _blank
click server "https://github.com/fedora-ci/ciboard-server/" "ciboard-server GitHub repositotry" _blank
click kaijs "https://github.com/fedora-ci/kaijs/" "kaijs GitHub repositotry" _blank
classDef focus stroke-width: 4
classDef outside stroke-dasharray: 4
To run the dashboard locally on your machine, you can simply run the npm start command in the project directory. This will start a server on http://localhost:3000 where you can access the dashboard frontend.
The default settings asssume that the backend, i.e. the ciboard GraphQL server, is served on /graphql on the same host as the frontend. To override this URL, you can use the REACT_APP_GRAPHQL_SERVER_URL environment variable:
$ REACT_APP_GRAPHQL_SERVER_URL=http://localhost:5000/graphql npm start
You can also use the .env.local file in the project root directory to override this setting globally so that you don't have the type the long command again and again:
$ echo 'REACT_APP_GRAPHQL_SERVER_URL=http://localhost:5000/graphql' > .env.local
$ npm start
In this project we follow the Google TypeScript Style Guide.
This project is licensed under the GNU Lesser General Public License v3.0.