ForkIQ

https://github.com/zzusec/forkiq

Admin

ForkIQ is a self-hosted single-user dashboard that connects via a GitHub App to automatically...

Tokens:21,991

Snippets:178

Trust Score:7.3

License:MIT

Update:3 days ago

Show doc for...

Tokens:

Raw

### Quick start setup commands

Source: https://github.com/zzusec/forkiq/blob/main/README.html

Commands to set up a Python virtual environment, install dependencies, set required environment variables, and start the Uvicorn server. Requires Python 3.10+ and a publicly accessible domain for GitHub App callbacks.

```bash
python3 -m venv .venv
.venv/bin/pip install -r requirements.txt

export FORKIQ_STATE_DIR="$PWD/state"      # 数据库与 App 私钥（默认 /var/lib/forkiq）
export FORKIQ_PEM_PATH="$FORKIQ_STATE_DIR/app.pem"
.venv/bin/uvicorn app.main:app --host 127.0.0.1 --port 8792
```

--------------------------------

### Enable and start ForkIQ systemd service

Source: https://github.com/zzusec/forkiq/blob/main/README.html

Command to reload systemd, enable and start the ForkIQ service. The service listens only on 127.0.0.1:8792 and is intended to be accessed via a reverse proxy that terminates HTTPS.

```bash
systemctl daemon-reload && systemctl enable --now forkiq
```

--------------------------------

### Run backend and frontend tests

Source: https://github.com/zzusec/forkiq/blob/main/README.html

Commands to run the Python unit tests for the engine and web layers, and the Node.js tests for the frontend script. The Python tests use a scripted fake GitHub client and FastAPI TestClient, while the UI tests execute app.js in isolated browser primitives.

```bash
.venv/bin/python -m unittest discover -s tests -p 'test_*.py'   # 引擎与 Web 层
node --test tests/test_ui.js                                    # 前端脚本
```

Tokens:

Raw