|
| 1 | +[](https://github.com/coderdojo-japan/dojocon2024.coderdojo.jp/actions?query=workflow%3A%22Test+%26+Deploy%22) |
| 2 | + |
| 3 | +<div id='dojocon-japan'></div> |
| 4 | + |
| 5 | +# [:yin_yang:](#dojocon-japan) DojoCon Japan 2024 公式サイト |
| 6 | + |
| 7 | +本ページは DojoCon Japan 公式Webサイトの公開リポジトリです。 |
| 8 | +本READMEでは、公式Webサイトの更新方法を目的別にまとめています。 |
| 9 | + |
| 10 | +( :octocat: [前年度のリポジトリ](#references)を引き継いで再活用しています) |
| 11 | + |
| 12 | +<br> |
| 13 | + |
| 14 | +<div id='how-to'></div> |
| 15 | + |
| 16 | +## [:white_check_mark:](#how-to) （共通）ブラウザで情報修正を提案できます |
| 17 | + |
| 18 | +どこを更新するにせよ **Webブラウザが一番簡単** だと思います...!! 😆 |
| 19 | + |
| 20 | +1. 下記の『[更新方法](#memo-webサイトの更新方法)』を参考に、修正を提案したい YAML ファイルをクリックする |
| 21 | +2. 画面右にある ✎ アイコン (Fork this project and edit this file) をクリックする |
| 22 | +3. 気になる箇所を修正し、修正内容にタイトルと説明文を付け、Propose file change をクリックする |
| 23 | +4. 修正内容を確認し、問題なければ Create pull request をクリックする |
| 24 | + |
| 25 | +以上で完了です。提案された修正内容は運営チームによって再確認され、問題なければ提案された内容が反映されます。もし修正内容に不具合があっても運営側で気付いて修正するので、まずはお気軽に提案してみてください :wink: |
| 26 | + |
| 27 | +<br> |
| 28 | + |
| 29 | +<div id='how-to-update'></div> |
| 30 | + |
| 31 | +## [:memo:](#how-to-update) Webサイトの更新方法 |
| 32 | + |
| 33 | +[`_data`](https://github.com/coderdojo-japan/dojocon2024.coderdojo.jp/tree/main/_data) フォルダ内に `ファイル名.yml` という YAML ファイルがあり、このファイルを修正すると Session 情報や Member 情報などを更新できます。 |
| 34 | + |
| 35 | +なおそれぞれの YAML ファイルは次のような形式で書かれています。 |
| 36 | + |
| 37 | +```yml |
| 38 | +# events.yml のデータ例 |
| 39 | + |
| 40 | +- title: ニンジャ大博覧会 |
| 41 | + text: ニンジャ大博覧会は、CoderDojoに参加する子どもたち（ニンジャ）によるオンラインと現地の2箇所で開催する作品展示会です。プログラミング作品はもちろん、マインクラフト作品もOK。ぜひみんなの作品を見せてください、楽しみにまってます！ |
| 42 | + img: /img/2023/event/ninja-big-expo.jpg |
| 43 | + time: オンライン＆現地 |
| 44 | + tag: 要申し込み |
| 45 | + url: /expo/ |
| 46 | +``` |
| 47 | +
|
| 48 | +追加・修正したい箇所に応じて、下記リンク先を[上記の修正手順](#white_check_mark-共通ブラウザで情報修正を提案できます)に沿って更新できます。 |
| 49 | +
|
| 50 | +- [`events.yml`](https://github.com/coderdojo-japan/dojocon2024.coderdojo.jp/blob/main/_data/events.yml): イベント情報を更新したい |
| 51 | +- [`members.yml`](https://github.com/coderdojo-japan/dojocon2024.coderdojo.jp/blob/main/_data/members.yml): スタッフ情報を更新したい |
| 52 | +- [`sessions.yml`](https://github.com/coderdojo-japan/dojocon2024.coderdojo.jp/blob/main/_data/sessions.yml): セッション情報を更新したい |
| 53 | +- [`sponsors.yml`](https://github.com/coderdojo-japan/dojocon2024.coderdojo.jp/tree/main/_data/sponsors.yml): スポンサー情報を更新したい |
| 54 | +- [`workshops.yml`](https://github.com/coderdojo-japan/dojocon2024.coderdojo.jp/blob/main/_data/workshops.yml): ワークショップ情報を更新したい |
| 55 | +- [`projects.yml`](https://github.com/coderdojo-japan/dojocon2024.coderdojo.jp/blob/main/_data/projects.yml): ニンジャ大博覧会の作品情報を更新したい |
| 56 | + |
| 57 | +<br> |
| 58 | + |
| 59 | +<div id='how-to-develop'></div> |
| 60 | + |
| 61 | +## [:hammer_and_wrench:](#how-to-develop) Webサイトを制作したい |
| 62 | + |
| 63 | +ローカル環境でWebサイトを修正・確認したい場合は **以下のいずれかの方法** でローカルサーバーを立ち上げてください。 |
| 64 | + |
| 65 | +### A. Docker イメージをリモートで構築する方法 |
| 66 | + |
| 67 | +```shell |
| 68 | +# 下記コマンドでローカル環境にWebサーバーが立ち上がります |
| 69 | +$ docker-compose up |
| 70 | +``` |
| 71 | + |
| 72 | +無事にローカルサーバーが立ち上がったら、[http://localhost:4000/](http://localhost:4000/) にアクセスしてWebサイトを修正・確認します。 |
| 73 | + |
| 74 | +### B. Docker イメージをローカルで構築する方法 |
| 75 | + |
| 76 | +```shell |
| 77 | +# Dockefile から dojocon-japan-2024 イメージを作成する |
| 78 | +$ docker build -t dojocon-japan-2024 -f Dockerfile . |
| 79 | +
|
| 80 | +# 下記コマンドでローカル環境にWebサーバーが立ち上がります |
| 81 | +$ docker-compose up |
| 82 | +``` |
| 83 | + |
| 84 | +無事にローカルサーバーが立ち上がったら、[http://localhost:4000/](http://localhost:4000/) にアクセスしてWebサイトを修正・確認します。 |
| 85 | + |
| 86 | +### C. Ruby をインストールして構築する方法 |
| 87 | + |
| 88 | +エラーなどで困ったら [Rails Girls インストール・レシピ](https://railsgirls.jp/install)を見るのがオススメです。 |
| 89 | +Ruby がインストールできれば十分で、 **Rails のインストールは不要** です。 |
| 90 | + |
| 91 | +```shell |
| 92 | +# macOS の場合: Homebrew ( https://brew.sh/index_ja ) 経由がオススメ |
| 93 | +$ brew install rbenv ruby-build |
| 94 | +
|
| 95 | +# Linux の場合: https://github.com/rbenv/rbenv#readme に沿って rbenv をインストール |
| 96 | +$ sudo apt install rbenv # Debian, Ubuntu 系のディストリビューションの場合 |
| 97 | +
|
| 98 | +# Windows の場合: 以下の Rails Girls インストール・レシピに沿ってインストール |
| 99 | +# https://railsgirls.jp/install |
| 100 | +
|
| 101 | +# Ruby 3.2.x をインストール |
| 102 | +$ rbenv install 3.2.0 |
| 103 | +
|
| 104 | +# Ruby が入っていることを確認 |
| 105 | +$ ruby --version |
| 106 | +
|
| 107 | +# 必要なライブラリをインストール |
| 108 | +$ bundle install |
| 109 | +
|
| 110 | +# ローカルサーバーを立ち上げる |
| 111 | +$ bundle exec jekyll server |
| 112 | +``` |
| 113 | + |
| 114 | +無事にローカルサーバーが立ち上がったら、[http://localhost:4000/](http://localhost:4000/) にアクセスしてWebサイトを修正・確認します。 |
| 115 | + |
| 116 | + |
| 117 | +<br> |
| 118 | + |
| 119 | +<div id='how-to-test'></div> |
| 120 | + |
| 121 | +## [:robot:](#how-to-test) リンク切れはテストで検知できます |
| 122 | + |
| 123 | +内部リンクのミスや `alt` 属性の記入忘れなどは次のコマンドでテストできます。([修正例を見る](https://github.com/coderdojo-japan/dojocon2023.coderdojo.jp/pull/105)) |
| 124 | + |
| 125 | +```shell |
| 126 | +# ローカルサーバーの立ち上げは不要です |
| 127 | +$ bundle exec rake test |
| 128 | +``` |
| 129 | + |
| 130 | +テスト内容の詳細は [`Rakefile`](https://github.com/coderdojo-japan/dojocon2024.coderdojo.jp/blob/main/Rakefile) をご参照ください。 |
| 131 | + |
| 132 | +上記テストは [GitHub Actions](https://github.com/coderdojo-japan/dojocon2024.coderdojo.jp/actions) 上でも動いています。GitHub Actionsで動かしているタスクは [`.github/workflows`](https://github.com/coderdojo-japan/dojocon2024.coderdojo.jp/tree/main/.github/workflows) ディレクトリから確認できます :eyes: :white_check_mark: |
| 133 | + |
| 134 | +<br> |
| 135 | + |
| 136 | +<div id='references'></div> |
| 137 | + |
| 138 | +## [:octocat:](#references) 関連リポジトリ |
| 139 | + |
| 140 | +- [coderdojo-japan/dojocon2023.coderdojo.jp](https://github.com/coderdojo-japan/dojocon2023.coderdojo.jp) |
| 141 | +- :memo: 2022年は [WordPress で構築](https://dojocon2022.coderdojo.jp/)されているため GitHub リポジトリは無し |
| 142 | +- [coderdojo-japan/dojocon2021.coderdojo.jp](https://github.com/coderdojo-japan/dojocon2021.coderdojo.jp) |
| 143 | +- [coderdojo-japan/dojocon2020.coderdojo.jp](https://github.com/coderdojo-japan/dojocon2020.coderdojo.jp) |
| 144 | +- [coderdojo-japan/dojocon2019.coderdojo.jp](https://github.com/coderdojo-japan/dojocon2019.coderdojo.jp) |
| 145 | +- [coderdojo-japan/dojocon2018.coderdojo.jp](https://github.com/coderdojo-japan/dojocon2018.coderdojo.jp) |
| 146 | +- [dojocon-japan/dojocon2017.coderdojo.jp](https://github.com/dojocon-japan/dojocon2017.coderdojo.jp) |
| 147 | +- [dojocon-japan/dojocon2016.coderdojo.jp](https://github.com/dojocon-japan/dojocon2016.coderdojo.jp) |
| 148 | + |
| 149 | +<br> |
| 150 | + |
| 151 | +<div id='license'></div> |
| 152 | + |
| 153 | +## [♻️](#license) License |
| 154 | + |
| 155 | +<details> |
| 156 | + <summary><strong>Check out each license</strong></summary> |
| 157 | + |
| 158 | +This web application is developed with many other brilliant works! |
| 159 | +Check out the followings if you are interested in. :wink: |
| 160 | + |
| 161 | +<h3>📝️ Texts, Logos, and Photos</h3> |
| 162 | + |
| 163 | +The texts and images, such as descriptions and thumbnails, company logos and staff photos, are owned by its content holder. Contact its owner, like the maintainer of linked external website or social account, before using them. 🔐 |
| 164 | + |
| 165 | +<h3>💎 Libraries and Codes</h3> |
| 166 | + |
| 167 | +The libraries like [RubyGems](https://rubygems.org/) used in this website have their own licenses. Say, this website uses [Jekyll](https://jekyllrb.com/), created by [The Jekyll Team](https://jekyllrb.com/team/) licensed under [The MIT License](https://github.com/jekyll/jekyll/blob/master/LICENSE). Thanks for their great works to make this website published! 💖 |
| 168 | + |
| 169 | +The source codes, such as HTML/CSS/JavaScript and Ruby codes not declared before, are published under [The MIT License](https://github.com/coderdojo-japan/dojocon2023.coderdojo.jp/blob/main/LICENSE.md). Feel free to refer, copy, or share them. And contact us if you find something unclear. |
| 170 | + |
| 171 | +<hr> |
| 172 | + |
| 173 | +<a href='https://github.com/coderdojo-japan/dojocon2024.coderdojo.jp/blob/main/LICENSE.md'>The MIT License</a> |
| 174 | + |
| 175 | +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: |
| 176 | + |
| 177 | +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. |
| 178 | + |
| 179 | +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. |
| 180 | + |
| 181 | +</details> |
| 182 | + |
| 183 | +<br> |
| 184 | + |
| 185 | +<div id='copyright'></div> |
| 186 | + |
| 187 | +## [©](#copyright) Copyright |
| 188 | + |
| 189 | +DojoCon Japan 2024 実行委員会 & 一般社団法人 CoderDojo Japan ([@coderdojo-japan](https://github.com/coderdojo-japan)). |
0 commit comments