girl is a Github Readme Link Checker
served over HTTP with Scala
and Spray.
A public version is hosted at http://derecho.elijah.cs.cmu.edu:8585/@demo.
http://derecho.elijah.cs.cmu.edu:8585/@top checks broken links in the top 1000 GitHub repositories by number of stars. This project found 416 broken links (with some false positives) when this feature was released on 2015/03/12. See the page's history on the Wayback Machine.
To prevent misuse, girl restricts usage to GitHub users with over 50 followers or users and organizations on the whitelist. Please add your accounts to the whitelist and submit a pull request to gain access. Thanks!
Before running locally,
set your GitHub API token
in the environment variable GITHUB_TOKEN,
or modify the GitHub API connection in
Girl.scala
to another option from
kohsuke.github.GitHub.
Also in Girl.scala, if desired, set the minimum number of
required followers to zero: val reqFollowers = 0.
girl is built with sbt.
Executing sbt run from the girl directory will download
the dependencies, compile the source code, and start
an HTTP server on 0.0.0.0:8585.
Main.scala
configures the interface and port.
sbt-revolver is helpful for development.
Start an sbt shell and execute ~re-start,
which re-compiles and restarts the server upon source code changes.
If you want to run locally but don't fancy installing sbt you can use docker to install girl into a local container. You will need to edit the Dockerfile to insert your github token. Then, in the girl directory:
docker build -t girl .
This will build and start the server on port 8585. Now you just need to point your browser at the ip of the container.
All portions are MIT-licensed.