FjordContributions
プログラミングスクール・フィヨルドブートキャンプのチーム開発プラクティスにて、受講生が関わった Issue や PullRequest 、Wiki を個人に焦点を当てて可視化できるサービスです。
GitHub の検索フォームに手入力して探しださずとも自動でデータを取得し、一覧表示できます。また、共有用 URL によって本サービスに登録していない人にも一覧表示を共有することも可能です。
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 .envOmniAuth の準備
OmniAuth の動作に必要な設定に関しては OAuthの設定 を参照してください。
Octokit の準備
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/rspecLint
次のコマンドで以下の lint をまとめて実行できます。
$ bin/lint-
Ruby
- rubocop
- slimlint
-
JavaScript
- eslint
- prettier
また、JavaScript の警告は次のコマンドで自動修正可能です。
$ npm run format使用技術
- Ruby 3.3.4
- Ruby and Rails 7.2.1
- PostgreSQL
- Hotwire
- turbo-rails 2.0.7
- stimulus-rails 1.3.4
- Slim 5.2.1
- TailwindCSS
- tailwindcss-rails 2.7.4
- Node.js 20.12.2
- Octokit 9.1.0
- Git 2.3.0
ログイン機能
- OmniAuth
- omniauth-github 2.0.1
- omniauth-rails_csrf_protection 1.0.2
テスティングフレームワーク
- RSpec
- rspec-rails 7.0.1
- factory_bot 6.4.6
計測ツール
- SimpleCov 0.22.0
Linter/Formatter
- RuboCop 1.66.1
- Slim-Lint 0.29.0
- ESLint 3.1.0
- Prettier 3.3.3
CI/CD
- GitHub Actions
インフラ
- Render.com
- Supabase
-