Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,39 @@
# hackathon-curator

Run the algo server:
**Grand Prize winner of the Man vs. Machine hackathon featured in [Wired](https://www.wired.com/story/san-francisco-hackathon-man-vs-machine/).**

Curator is a tiny toolkit that captures GitHub diffs, scores every token for risk, and overlays a heatmap so reviewers immediately see what matters.

## Product screenshots

![Run Curator button on a GitHub pull request](docs/screenshots/pr-run-curator.svg)

![Token risk heatmap overlay on diff content](docs/screenshots/heatmap-overlay.svg)

![Curator reviewer panel with highlighted diffs](docs/screenshots/curator-sidebar.svg)

![Curator flow from diff capture to reviewer guidance](docs/screenshots/curator-flow.svg)

## Run the algo server
```
cd algo
npm install
npm run dev
# localhost:3005
```

Run the test server:
## Run the test server
```
cd test-server
npm install
npm run dev
# localhost:3030
```

Run the curator extension:
## Run the curator extension
```
cd curator
npm install
npm run watch
npm run dev #in new terminal
npm run dev # in new terminal
```
27 changes: 27 additions & 0 deletions docs/screenshots/curator-flow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions docs/screenshots/curator-sidebar.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions docs/screenshots/heatmap-overlay.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions docs/screenshots/pr-run-curator.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.