NOTE: This is no longer in active development, watchtowner is the replacement.
Your most trusted local assistant. Squire's aim is to provide a focused, product view of your GitHub organisation.
| Feature | Description |
|---|---|
| Group by product | Use github topics to group repositories by product |
| See open PRs | Dashboard allows you to see all open PRs for all products as well as drill down to open PRs by product |
| Sec vulnerability | See open security vulnerabilities for your product suite |
| Insights | Get insights on PRs and security metrics for all products, or per product basis. |
| Basic reports | Download basic reports from your product's page in JSON format (other format's supporting coming soon) |
NOTE: we've added a makefile to help with orchestrating.
To install dependencies:
make install
touch .env.local # your local env file# ================================
# Client: Squire app
# ================================
VITE_DB_FILE_PATH="$PROJECT_ROOT/.db/squire.duckdb"
VITE_LOG_LEVEL="debug"
VITE_GH_TOKEN=<your-token>
VITE_GH_OWNER=<your-org>
# ================================
# Pre-Ingest
# ================================
TOPICS_TO_INGEST=comma,delimited,list,to,ingest
A new pre-ingest app has been re-written to be idempotent
and use the same env variables as the app. Ensure you add the env var TOPICS_TO_INGEST to the config file,
which is a comma-delimited list.
make dev-ingestrun the client locally
make dev-appAccess the webpage on http://localhost:5173/
The Common issue is to have a segmentation fault with the duck async library. It requires a full clean, you need to run the following command to reset the app to a clean slate
make reset-stateAfter you can run the pre-ingest command make dev-ingest to hydrate all the data.