|
| 1 | +# :yin_yang: Teaser Site Template for CoderDojo Conferences like [DojoCon](https://dojocon.coderdojo.jp/) / [DecaDojo](https://decadojo.coderdojo.jp/) |
| 2 | + |
| 3 | +[](https://teaser-template.coderdojo.jp/) |
| 4 | + |
| 5 | +<br> |
| 6 | + |
| 7 | +<div id='howto'></div> |
| 8 | + |
| 9 | +## :beginner: 本テンプレートの使い方 |
| 10 | + |
| 11 | +[承認された CoderDojo](https://coderdojo.jp/#dojos) であれば、以下の手順で本テンプレートをお使いいただけます。 |
| 12 | + |
| 13 | +1. [GitHub](https://github.co.jp/) のアカウントを作る |
| 14 | +1. 本ページの画面右上にある `Use this template` -> `Create a new repository` を押す |
| 15 | +  |
| 16 | +1. 各項目に情報を入力し、本テンプレートから新しいリポジトリを作成する |
| 17 | +  |
| 18 | +1. [README の動かす方法](#setup)にしたがって、適宜Webサイトを修正・確認する |
| 19 | +1. 準備ができたら [GitHub Pages](https://www.google.com/search?q=GitHub+Pages) から公開する |
| 20 | + - `Settings` -> `Pages` に行き、`Branch` 欄にある `None` を `main` に変更し、`Save` を押す |
| 21 | + - `Custom domain` 欄が表示されたらドメイン名 (例: `dojocon2024.coderdojo.jp`) を入力し、`Save` を押す |
| 22 | + - :warning: ドメインの適用には DNS 設定が必要です。ココまで設定できたら @yasulab までご連絡ください! :email: :dash: |
| 23 | +  |
| 24 | +1. DNS 設定が完了したら、ティザーサイトが公開できているはずです! |
| 25 | + - 公開例: [https://teaser-template.coderdojo.jp/](https://teaser-template.coderdojo.jp/) |
| 26 | + |
| 27 | +<div id='setup'></div> |
| 28 | + |
| 29 | +<br> |
| 30 | + |
| 31 | +## :wrench: Ruby / Python / Node.js / PHP で動かす方法 |
| 32 | + |
| 33 | +### 共通 |
| 34 | + |
| 35 | +下記の手順でサーバーが無事立ち上がったら [`index.html`](https://github.com/coderdojo-japan/teaser-template.coderdojo.jp/blob/main/index.html) を修正し、[http://localhost:8080/](http://localhost:8080/) にアクセスして修正内容を確認します。 |
| 36 | + |
| 37 | +### Ruby で動かす方法 |
| 38 | + |
| 39 | +```shell |
| 40 | +# Ruby がインストールされていることを確認する (無ければインストールする) |
| 41 | +$ ruby --version |
| 42 | + |
| 43 | +# ローカルサーバーを立ち上げる |
| 44 | +$ ruby -run -e httpd |
| 45 | +``` |
| 46 | + |
| 47 | +<br> |
| 48 | + |
| 49 | + |
| 50 | +### Python で動かす方法 |
| 51 | + |
| 52 | +```shell |
| 53 | +# Python がインストールされていることを確認する (無ければインストールする) |
| 54 | +$ python --version |
| 55 | + |
| 56 | +# ローカルサーバーを立ち上げる |
| 57 | +$ python -m SimpleHTTPServer 8080 |
| 58 | +``` |
| 59 | + |
| 60 | +<br> |
| 61 | + |
| 62 | + |
| 63 | +### Node.js で動かす方法 |
| 64 | + |
| 65 | +```shell |
| 66 | +# Node.js の npx がインストールされていることを確認する (無ければインストールする) |
| 67 | +$ npx --version |
| 68 | + |
| 69 | +# ローカルサーバーを立ち上げる |
| 70 | +$ npx http-server |
| 71 | +``` |
| 72 | + |
| 73 | +<br> |
| 74 | + |
| 75 | + |
| 76 | +### PHP で動かす方法 |
| 77 | + |
| 78 | +```shell |
| 79 | +# PHP がインストールされていることを確認する (無ければインストールする) |
| 80 | +$ php --version |
| 81 | + |
| 82 | +# ローカルサーバーを立ち上げる |
| 83 | +$ php -S localhost:8080 |
| 84 | +``` |
| 85 | + |
| 86 | +<br> |
| 87 | + |
| 88 | + |
| 89 | +## :octocat: 関連リポジトリ |
| 90 | + |
| 91 | +- [GitHub - DojoCon Japan リポジトリ一覧](https://github.com/search?q=org%3Acoderdojo-japan%20dojocon&type=repositories) |
| 92 | +- [GitHub - CoderDojo Japan organization](https://github.com/coderdojo-japan) (approved by [GitHub for Nonprofit](https://news.coderdojo.jp/2019/08/29/github-for-nonprofit/)) |
| 93 | + |
| 94 | +<br> |
| 95 | + |
| 96 | +<div id='license'></div> |
| 97 | + |
| 98 | +## :handshake: Credits & Works |
| 99 | + |
| 100 | +- :yin_yang: The CoderDojo logo in header - See the [CoderDojo Charter](https://coderdojo.jp/charter). |
| 101 | +- :camera_flash: The CoderDojo object in footer is crafted by [DojoCon Japan 2016](https://dojocon2016.coderdojo.jp/) team and photo by [@yasulab](https://github.com/yasulab). |
| 102 | +- :art: This template is based on the [DojoCon Japan 2023](https://dojocon2023.coderdojo.jp/)'s teaser site, designed by [@kwaka1208](https://github.com/kwaka1208). |
| 103 | + |
| 104 | +Other than the logo and photo above, the source codes, such as HTML and CSS, are published under [The MIT License](https://github.com/coderdojo-japan/teaser-template.coderdojo.jp/blob/main/LICENSE.md). Feel free to refer, copy, or share them. |
| 105 | + |
| 106 | +----- |
| 107 | + |
| 108 | +Copyright © [DojoCon Japan](https://dojocon.coderdojo.jp/) & [CoderDojo Japan](https://github.com/coderdojo-japan) |
0 commit comments