CoderDojo Japan

一般社団法人 CoderDojo Japan の公式サイトです。Ruby on Rails で実装されています。本ページでは、トップページに掲載されている Dojo 情報を更新する方法や、開発環境のセットアップ方法などをまとめています。

🔰 Dojo を掲載するには?

CoderDojo を立ち上げ、承認されたら、CoderDojo Kata にある支援プログラムをご利用することができます。coderdojo.jp への掲載方法も載っていますので、詳細は CoderDojo Kata をご確認ください。

🔧 開発に参加するには?

coderdojo.jp の開発には以下のいずれかの方法で参加できます。Dojo 情報の修正やドキュメントの追加・執筆であれば、ブラウザだけで参加できます。

1. Dojo 情報を更新する場合 (» 詳細を見る)
   • 必要なもの: ブラウザ + GitHub アカウント
2. CoderDojo Kata を更新する場合 (» 詳細を見る)
   • 必要なもの: ブラウザ + GitHub アカウント
3. 新機能の開発やデザインを改善する場合 (» 詳細を見る)
   • 必要なもの: Ruby on Rails + PostgreSQL などの各種開発環境

ちょっとした情報更新や文言修正であればブラウザだけで参加できるのが特徴で、それぞれの手順は以下の通りです ✨📝💨

1. Dojo 情報を更新する

Dojo 情報は次の手順で簡単に更新できます。

1. db/dojos.yaml を開く
2. 画面右にある ✎ アイコン (Fork this project and edit this file) をクリックする
3. 気になる箇所を修正し、修正内容にタイトルと説明文を付け、Propose file change をクリックする
4. 修正内容を確認し、問題なければ Create pull request をクリックする
   • ☯️ Dojo のロゴ画像を追加/変更したい場合は Pull Request のコメント欄に画像を添付して頂けると助かります 😌 (対応例1 / 対応例2 / 対応例3)

以上で完了です。提案された修正はメンテナーによってチェックされ、問題なければ提案された内容が反映されます。もし問題があってもメンテナー側で気付いて修正できるので、まずはお気軽に提案してみてください 😉

https://coderdojo.jp/docs にあるドキュメントの編集方法も同様です。db/docsディレクトリをブラウザで開き、修正したいファイルをクリックして、修正内容を提案してください。同ディレクトページの右上にある Create new file ボタンをクリックすると、新しいドキュメントの追記を提案することもできます。

2. Kata 情報を更新する

Kata 情報も、Dojo 情報と同様の方法で更新できます。

1. kata.html.erb を開く
2. 画面右にある ✎ アイコン (Fork this project and edit this file) をクリックする
3. 気になる箇所を修正し、修正内容にタイトルと説明文を付け、Propose file change をクリックする
4. 修正内容を確認し、問題なければ Create pull request をクリックする (対応例)

以上で完了です。提案された修正はメンテナーによってチェックされ、問題なければ提案された内容が反映されます。もし問題があってもメンテナー側で気付いて修正できるので、まずはお気軽に提案してみてください 😉

3. 新機能の開発やデザインを改善する

本サイトでは以下の技術が使われているので、それぞれのツールをセットアップします。

• Ruby
• Ruby on Rails
• PostgreSQL

セットアップ方法の方法は次の通りです。

1. 本リポジトリを fork 後、clone します
2. ターミナルから $ bin/setup を実行します
3. $ rails server でローカルサーバーを立ち上げます
4. ブラウザから localhost:3000 にアクセスします
5. coderdojo.jp と同様のサイトが表示できれば完了です

🐳 Docker を利用したセットアップ方法

上記の他、Docker を使ったセットアップ方法もあります。Docker をインストールし、下記の手順でセットアップしてください 🛠💨

Doorkeeperのイベントを取得するために、こちらでPublic API Access Tokenを生成しておく必要があります。

1. 本リポジトリを fork 後、clone します
2. .env.sample をコピーして .env にリネームします
3. .envに、環境変数DOORKEEPER_API_TOKEN=<生成したPublic API Access Token> を追記します
4. ターミナルから $ docker-compose up を実行します
5. ターミナルから $ docker-compose exec rails bin/setup を実行します
6. ブラウザから localhost:3000 にアクセスします
7. coderdojo.jp と同様のサイトが表示できれば完了です

🚀 CI/Deploy 構成

coderdojo.jp は現在、次の構成でテスト・デプロイされています。

• CI: GitHub Actions
• Deploy: Heroku + Release Phase
• 関連PR: replace travis with github actions and heroku integration

各コミットが push される度に CI が動きます。main ブランチに新しいコミットが追加され、CI が pass すると、Heroku 側でデプロイ前/デプロイ後の各種スクリプトが実行されます。

• テスト(CI): .github/workflows/test.yml
• デプロイ前: Bundle, Asset Precomiple, Heroku Buildpack など
• デプロイ後: scripts/release.sh, Procfile

GitHub Actions に deploy workflow を入れることもできましたが、次の２つの目的から現在は分離しています。

1. CI フローと Deploy フローの責務を分離し、本番環境のログの機密性を高める
   • 例: デプロイ関連のログは Heroku Activity Logs に集約させ、誰でもアクセスできる状態にしない
2. Heroku Release Phase を使い、本番環境の安定性を高める
   • 例: Heroku デプロイ後に実行するスクリプトが失敗したとき、デプロイ自体がロールバックするようにし、本番環境が落ちる可能性を小さくする

💎 CI で実行される各種 Ruby スクリプト (Rake タスク)

最新版は 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

4. 他、開発に関する資料

開発に関する資料は /docs や下記サイトにまとめてあります (最新順)。必要に応じて適宜ご参照ください。

• DojoCast を Jekyll から Rails に移行しました
• 新規 Dojo の追加方法 - GitHub
• 子どものためのプログラミング道場『CoderDojo』の Ruby/Rails 活用事例
• CoderDojo を支える Rails CMS の活用事例 - Speaker Deck
• 2020年 coderdojo.jp 開発ふりかえり
• 2019年 coderdojo.jp 開発ハイライト
• 2018年 運用目線で見る coderdojo.jp 開発
• CoderDojo Japan の各種機能と実装について【2017年版】 - Qiita
• CoderDojo Japan のバックエンドを刷新しました【2016年】

🤝 API

現在提供中の API の一覧です。利用例のある API は互換性を意識して開発されるため、比較的使いやすいです。ただし予告なく破壊的な変更が行われる可能性もあるため、あらかじめご了承いただけると幸いです 🚧

• Podcast API: https://coderdojo.jp/podcasts.rss
  • 利用例: 📻 Apple Podcasts - DojoCast (関連PR: coderdojo.jp#387)
• Dojo API: https://coderdojo.jp/dojos.json
  • 利用例: 📰 DojoNews - GitHub (関連PR: coderdojo.jp#1433)
• Event API: https://coderdojo.jp/events.json
  • 利用例: 🗾 DojoMap - GitHub (関連PR: map.coderdojo.jp#10)
  • 利用例: 📅 CoderDojo カレンダーを作ってみた (関連PR: coderdojo.jp#1547)

なお本サイト内 DB の各テーブルおよびそのデータ（一般公開部分のみ）は、以下のファイルからご確認いただけます。

• DB テーブル: db/schema.rb
• Dojo データ: db/dojos.yaml
• Event データ (の情報取得元): db/dojo_event_services.yaml
  • 📝 １つの Dojo が複数のイベント管理サービスを使う事例もあるため Dojo has_many DojoEventServices となっています。

📜 Development History & Contributors

• 2012: CoderDojo Japan started in Facebook Group
• 2014: coderdojo.jp was launched as 'coderdojo-japan.github.io'
• 2015: coderdojo.jp was migrated to Parse as 'web'
• 2016: Parse shutdown. @yasulab migrated 'coderdojo.jp' from Parse to Ruby on Rails
  • Thanks @cognitom for helps in design.
  • Thanks @YassLab team for helps in development.
  • cf. Contributors - coderdojo-japan/coderdojo.jp - GitHub
• 2016-now: coderdojo.jp is sustainably maintained and developed by YassLab Inc.
  • CoderDojo Japan has been incorporated and approved @YassLab team as one of official partners for tons of works.
  • From then on, YassLab Inc. maintains and develops coderdojo.jp with official approval from CDJ board members. See #References and contributions ('coderdojo-japan.github.io', 'web', and 'coderdojo.jp') for their continuous efforts on development.

5. License

Check out each license

This web application is developed with many other brilliant works!
Check out the followings if you are interested in. 😉

🎨 Libraries & Icons

The libraries like RubyGems used in this web application have their own licenses. Say, this website uses Bootstrap, created by Twitter licensed under the MIT License.

Also this website uses icons created by Font Awesome, licensed under SIL OFL 1.1, and Twemoji, created by Twitter, licensed under the MIT License.

Thanks for their great works to make this app published! 💖

📝 Texts in Kata

The texts in Kata page are published under CC BY-NC-SA 4.0 license. But the texts do NOT include images, slides, and external websites. Please make sure to check their licenses and/or contact its owner before using them.

☯️ Logos & Photos

The images, such as logos and photos of each dojo, are NOT published under the following License. Contact its owner, like the maintainer of linked external website, before using them. 😌

💎 Codes, Scrivito gem, and Others

The source codes, such as HTML/CSS/JavaScript and Ruby codes not declared before, are published under The MIT License. Feel free to refer, copy, or share them. And contact info@coderdojo.jp if you find something unclear.

Also Scrivito gem is publishd under LGPL-3.0, but the author allows us to put MIT license. 😆✨

Sorry for the late reply, I wanted to confer with our team.
There is no conflict in the licenses and you are welcome to use the MIT license.

So, this application's code can be simply forked, copied, and modified under the MIT License below! 🆗

---

The MIT License

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.

Copyright © 一般社団法人 CoderDojo Japan