ue5377 / dashboard Goto Github PK

View Code? Open in Web Editor NEW

This project forked from packit/dashboard

Packit-service web UI dashboard

License: MIT License

Shell 0.43% JavaScript 0.38% Python 3.55% TypeScript 93.38% Makefile 1.18% HTML 0.71% Dockerfile 0.35%

dashboard's Introduction

Dashboard for Packit

dashboard.packit.dev

Dashboard for Packit Service.

Uses Packit Service API (or the staging API for the staging instance).

Local Development

Running the dashboard locally

# install dependencies
:~/dashboard $ make install-dependencies

# this will start the flask development server
:~/dashboard $ make run-dev-flask
# in another terminal
:~/dashboard $ make run-dev-frontend

# use the frontend application for development
# it will proxy non react requests to flask during dev
# read the Makefile for details

(you make have to use modify the make command if you want to run flask in a virtulenv instead of using python3-flask from the fedora repos.)

# to create a production build of react and/or any other javascript libs
:~/dashboard $ make transpile-prod
# now forget everything about npm, deploy flask the usual way

Running the dashboard in a container

:~/dashboard $ make run-container-stg

For more details, see the contribution guide.

Pre-commit

Note

For more details on pre-commit see https://github.com/packit/contributing#pre-commit

Running pre-commit is recommended for development, this will run a few tasks that are helpful

# install pre-commit on your system
:~/dashboard $ pip3 install pre-commit
# add pre-commit to git hooks for committing and pushing
:~/dashboard $ pre-commit install -t pre-commit -t pre-push