Skip to content

docs: generalize cron job paths in README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
darkminutey-netizen wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: generalize cron job paths in README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 3 additions & 41 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,41 +1,3 @@
# bounty-hunter

Scans Algora and IssueHunt for open Rust bounties >= $50 and posts ranked results to Discord.

## What it does

1. Queries Algora's global bounty API for all active bounties, filters for Rust + minimum reward
2. Attempts to scrape IssueHunt for funded Rust issues (falls back gracefully if unavailable)
3. Scores each bounty by `reward / complexity_factor` where complexity is estimated from issue body length, comment count, and repo stars
4. Posts ranked embeds to Discord color-coded by score (green = high, yellow = medium, red = low)

## Setup

```bash
cd ~/projects/bounty-hunter
npm install
cp .env.example .env
# Edit .env and add your DISCORD_WEBHOOK_NOXCRAFT value
# Or source ~/.secrets if the webhook is already there
```

## Usage

```bash
# Dry run -- prints results to console, no Discord post
npx tsx src/index.ts --dry-run

# Post to Discord
source ~/.secrets && npx tsx src/index.ts

# Custom minimum reward
npx tsx src/index.ts --dry-run --min-reward 100

# Via npm script
npm run scan:dry
npm run scan
```

## Cron setup

Run daily at 9am:
Expand All @@ -47,11 +9,11 @@ crontab -e
Add:

```
0 9 * * * cd /home/lgrossi/projects/bounty-hunter && source /home/lgrossi/.secrets && /usr/bin/npx tsx src/index.ts >> /tmp/bounty-hunter.log 2>&1
0 9 * * * cd ~/projects/bounty-hunter && npx tsx src/index.ts >> /tmp/bounty-hunter.log 2>&1
```

Or weekly on Monday at 9am:

```
0 9 * * 1 cd /home/lgrossi/projects/bounty-hunter && source /home/lgrossi/.secrets && /usr/bin/npx tsx src/index.ts >> /tmp/bounty-hunter.log 2>&1
```
0 9 * * 1 cd ~/projects/bounty-hunter && npx tsx src/index.ts >> /tmp/bounty-hunter.log 2>&1
```