README.md

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

Option 1: Using system packages (Fedora/RHEL)

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

Option 2: Using pip/virtualenv

# create a virtual environment (optional but recommended)
:~/dashboard $ python3 -m venv venv
:~/dashboard $ source venv/bin/activate

# install the package with dependencies
:~/dashboard $ pip install -e .

# install test dependencies (if running tests)
:~/dashboard $ pip install -e '.[testing]'

# install pnpm and frontend dependencies
:~/dashboard $ sudo dnf install pnpm
:~/dashboard $ cd frontend && pnpm install && cd ..

Start the development servers

# 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

More Info

If you'd like to know more about packit, please check:

• Our website: packit.dev
• Packit Service
• Packit