プログラミングスクール・フィヨルドブートキャンプのチーム開発プラクティスにて、受講生が関わった Issue や PullRequest 、Wiki を個人に焦点を当てて可視化できるサービスです。
GitHub の検索フォームに手入力して探しださずとも自動でデータを取得し、一覧表示できます。また、共有用 URL によって本サービスに登録していない人にも一覧表示を共有することも可能です。
https://fjordcontributions.onrender.com
$ git clone https://github.com/ymmtd0x0b/FjordContributions.git
$ cd FjordContributions
本プロジェクトではアカウント登録・ログイン機能に OmniAuth による GitHub 認証を、GitHub 上のデータの取得に Octokit を使用しています。
起動する前に以下の設定を行ってください。
OmniAuth、Octokit の双方は環境変数を通して取得した機密情報 (以降で設定します) を基に動作します。
dotenv を導入しているため .envファイル を作成することで、お使いのシステムに手を加えること無く環境変数を設定可能です。
- .envファイルの作成
$ touch .env
OmniAuth の動作に必要な設定に関しては OAuthの設定 を参照してください。
Octokit の動作に必要な設定に関しては Personal access token の設定 を参照してください。
機密情報とは別にプロジェクトの動作に必要な環境変数を追記します。
# .env
...
BOOTCAMP_REPOSITORY_ID = '5139175'
GITHUB_URL = 'https://github.com'
ここまでの準備に問題がなければ、次のコマンドでセットアップが正常に動作します。
$ bin/setup
$ bin/dev
起動後は http://localhost:3000/ にアクセスしてください。
$ bin/rspec
$ HEADFULL=1 bin/rspec
次のコマンドで以下の lint をまとめて実行できます。
$ bin/lint
-
Ruby
- rubocop
- slimlint
-
JavaScript
- eslint
- prettier
また、JavaScript の警告は次のコマンドで自動修正可能です。
$ npm run format
- Ruby 3.3.4
- Ruby and Rails 7.2.1
- PostgreSQL 16.4
- Node.js 20.12.2
- Hotwire
- turbo-rails
- stimulus-rails
- Slim
- TailwindCSS
- tailwindcss-rails
- Octokit
- Git
- OmniAuth
- omniauth-github
- omniauth-rails_csrf_protection
- RSpec
- rspec-rails
- factory_bot
- SimpleCov
- RuboCop
- Slim-Lint
- ESLint
- Prettier
- GitHub Actions
- Render.com