starseeker
Seek your following's stars!
http://starseeker.so
About
Starseeker is an application that helps you track the GitHub stars of people you follow. It provides notifications about hot repositories starred by your network.
Requirements
- Git (>= 2.0.0)
- Docker (>= 2.1.0)
Setup
$ git clone https://github.com/tricknotes/starseeker.git
$ cd starseeker
$ docker compose run --rm app bundle install
$ docker compose run --rm app bin/rails db:create db:migrate
Fetch star events from GitHub for local development.
$ docker compose run --rm app bin/rails star_events:fetch
Setup environment variables that are described in compose.yml:
GITHUB_CLIENT_ID: Your GitHub OAuth application client IDGITHUB_SECRET: Your GitHub OAuth application secretGITHUB_TOKEN: Your GitHub personal access tokenGITHUB_LOGIN: Your GitHub usernameBASE_URL: Base URL for the application (defaults to http://localhost:3000)
You can set these variables in your environment or use a .env file.
And run:
$ docker compose up -d app
The application will be available at http://localhost:3000
Preview the daily mail at http://localhost:3000/rails/mailers, exactly as it
is delivered (styles inlined). It is built for the first user in the database
the same way the daily job builds it, so it asks GitHub for that user's
followings and shows what star_events:fetch collected from them. Mails that
were actually sent are kept at http://localhost:3000/letter_opener
Tasks
Fetch star events of each user's followings from GitHub (looks back 2 hours by
default; set hours or FETCH_HOURS to change it):
$ docker compose run --rm app bin/rails star_events:fetch
$ docker compose run --rm app bin/rails "star_events:fetch[24]"
Schedule users to be sent the daily mail:
$ docker compose run --rm app bin/rails schedule_sending_hot_repositories
Send daily hot repositories mail to scheduled users:
$ docker compose run --rm app bin/rails send_hot_repositories
Remove star events older than 7 days (set KEEP_MAX_OLD_EVENT_DAY to change it):
$ docker compose run --rm app bin/rails remove_old_events
Update user account info:
$ docker compose run --rm app bin/rails update_account_info
Test
$ docker compose run --rm -e RAILS_ENV=test app bin/rails db:migrate
$ docker compose run --rm app bundle exec rspec
License
(The MIT License)
Copyright (c) 2012- Ryunosuke SATO <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
