☯️ CoderDojo Japan (@coderdojo-japan) official website developed by Ruby on Rails with @YassLab team. 💎
一般社団法人 CoderDojo Japan の公式サイトです。プログラミング言語『Ruby』と、Rubyを活用したフレームワーク『Ruby on Rails』で開発されています。本ページでは、トップページに掲載されている Dojo 情報を更新する方法や、開発環境のセットアップ方法などをまとめています。
CoderDojo を立ち上げ、承認されたら、CoderDojo Kata にある支援プログラムをご利用することができます。coderdojo.jp への掲載方法も載っていますので、詳細は CoderDojo Kata をご確認ください。
coderdojo.jp の開発には以下のいずれかの方法で参加できます。Dojo 情報の修正やドキュメントの追加・執筆であれば、ブラウザだけで参加できます。
ちょっとした情報更新や文言修正であればブラウザだけで参加できるのが特徴で、それぞれの手順は以下の通りです ✨📝💨
Dojo 情報は次の手順で簡単に更新できます。
以上で完了です。提案された修正はメンテナーによってチェックされ、問題なければ提案された内容が反映されます。もし問題があってもメンテナー側で気付いて修正できるので、まずはお気軽に提案してみてください :wink:
[!NOTE] https://coderdojo.jp/docs にあるドキュメントの編集方法も同様です。db/docsディレクトリをブラウザで開き、修正したいファイルをクリックして、修正内容を提案してください。同ディレクトページの右上にある
Create new file
ボタンをクリックすると、新しいドキュメントの追記を提案することもできます。
Kata 情報も、Dojo 情報と同様の方法で更新できます。
以上で完了です。提案された修正はメンテナーによってチェックされ、問題なければ提案された内容が反映されます。もし問題があってもメンテナー側で気付いて修正できるので、まずはお気軽に提案してみてください :wink:
本サイトでは以下の技術が使われているので、それぞれのツールをセットアップします。
セットアップ方法の方法は次の通りです。
$ bin/setup
を実行します$ rails server
でローカルサーバーを立ち上げます上記の他、Docker を使ったセットアップ方法もあります。Docker をインストールし、下記の手順でセットアップしてください 🛠💨
Doorkeeperのイベントを取得するために、こちらでPublic API Access Tokenを生成しておく必要があります。
.env.sample
をコピーして .env
にリネームします.env
に、環境変数DOORKEEPER_API_TOKEN=<生成したPublic API Access Token>
を追記します$ docker-compose up
を実行します$ docker-compose exec rails bin/setup
を実行しますcoderdojo.jp は現在、次の構成でテスト・デプロイされています。
各コミットが push される度に CI が動きます。main
ブランチに新しいコミットが追加され、CI が pass すると、Heroku 側でデプロイ前/デプロイ後の各種スクリプトが実行されます。
GitHub Actions に deploy
workflow を入れることもできましたが、次の2つの目的から現在は分離しています。
最新版は scripts/release.sh からご確認いただけます。
# データベースのマイグレーション
bundle exec rails db:migrate
# 開発用データの流し込み(seeding)
bundle exec rails db:seed
# db/dojos.yaml の内容をDBに反映するタスク
bundle exec rails dojos:update_db_by_yaml
# DBの内容を db/dojos.yaml に反映するタスク
bundle exec rails dojos:migrate_adding_id_to_yaml
# 近日開催の道場を更新するタスク
bundle exec rails dojo_event_services:upsert
# ポッドキャスト「DojoCast」のデータを反映するタスク
bundle exec rails podcasts:upsert
開発に関する資料は /docs や下記サイトにまとめてあります (最新順)。必要に応じて適宜ご参照ください。
現在提供中の API 一覧です。利用例のある API は互換性を意識して開発されるため、比較的使いやすいです。ただし予告なく破壊的な変更が行われる可能性もあるため、あらかじめご了承いただけると幸いです 🚧
なお本サイト内 DB の各テーブルおよびそのデータ(一般公開部分のみ)は、以下のファイルからご確認いただけます。
db/schema.rb
db/dojos.yaml
db/dojo_event_services.yaml
Dojo has_many DojoEventServices
となっています。This web application is developed with many other brilliant works! :sparkling_heart:
You can check out them and our works with associated licenses from LICENSE.md. :wink:
Copyright © 一般社団法人 CoderDojo Japan (@coderdojo-japan).