Skip to content

Commit 98cfe2a

Browse files
authored
Initial commit
0 parents  commit 98cfe2a

29 files changed

+343
-0
lines changed

.gitignore

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Ignore files for Jekyll
2+
_site
3+
.sass-cache
4+
.jekyll-cache
5+
.jekyll-metadata
6+
vendor
7+
8+
# Ignore files for Ruby
9+
*.gem
10+
*.rbc
11+
/.config
12+
/coverage/
13+
/InstalledFiles
14+
/pkg/
15+
/spec/reports/
16+
/spec/examples.txt
17+
/test/tmp/
18+
/test/version_tmp/
19+
/tmp/
20+
21+
# Used by dotenv library to load environment variables.
22+
# .env
23+
24+
# Ignore Byebug command history file.
25+
.byebug_history
26+
27+
## Specific to RubyMotion:
28+
.dat*
29+
.repl_history
30+
build/
31+
*.bridgesupport
32+
build-iPhoneOS/
33+
build-iPhoneSimulator/
34+
35+
## Specific to RubyMotion (use of CocoaPods):
36+
#
37+
# We recommend against adding the Pods directory to your .gitignore. However
38+
# you should judge for yourself, the pros and cons are mentioned at:
39+
# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
40+
#
41+
# vendor/Pods/
42+
43+
## Documentation cache and generated files:
44+
/.yardoc/
45+
/_yardoc/
46+
/doc/
47+
/rdoc/
48+
49+
## Environment normalization:
50+
/.bundle/
51+
/vendor/bundle
52+
/lib/bundler/man/
53+
54+
# for a library or gem, you might want to ignore these files since the code is
55+
# intended to run in multiple environments; otherwise, check them in:
56+
# Gemfile.lock
57+
# .ruby-version
58+
# .ruby-gemset
59+
60+
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
61+
.rvmrc
62+
63+
# Used by RuboCop. Remote config files pulled in from inherit_from directive.
64+
# .rubocop-https?--*
65+

CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
teaser-template.coderdojo.jp

LICENSE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
MIT License
2+
3+
:memo: **NOTE: This applies only for source codes, not logos and images. See [README#license](https://github.com/coderdojo-japan/teaser-template.coderdojo.jp#license) for details.**
4+
5+
Copyright (c) 2024 [DojoCon Japan](https://dojocon.coderdojo.jp/) & [CoderDojo Japan](https://github.com/coderdojo-japan)
6+
7+
Permission is hereby granted, free of charge, to any person obtaining a copy
8+
of this software and associated documentation files (the "Software"), to deal
9+
in the Software without restriction, including without limitation the rights
10+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
copies of the Software, and to permit persons to whom the Software is
12+
furnished to do so, subject to the following conditions:
13+
14+
The above copyright notice and this permission notice shall be included in all
15+
copies or substantial portions of the Software.
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23+
SOFTWARE.

README.md

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# :yin_yang: Teaser Site Template for CoderDojo Conferences like [DojoCon](https://dojocon.coderdojo.jp/) / [DecaDojo](https://decadojo.coderdojo.jp/)
2+
3+
[![Screenshot of Teaser Site](https://github.com/coderdojo-japan/teaser-template.coderdojo.jp/blob/main/img/screenshot.gif?raw=true)](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+
![Screenshot: Use this template](https://i.gyazo.com/559ee68cbe9e7e94b41e68237b36d3cd.png)
16+
1. 各項目に情報を入力し、本テンプレートから新しいリポジトリを作成する
17+
![Screenshot: Create with template](https://github.com/coderdojo-japan/teaser-template.coderdojo.jp/blob/main/img/create-with-template.png?raw=true)
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+
![Screenshot: GitHub Pages Settings](https://github.com/coderdojo-japan/teaser-template.coderdojo.jp/blob/main/img/pages-settings.png?raw=true)
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)

browserconfig.xml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<browserconfig>
3+
<msapplication>
4+
<tile>
5+
<square150x150logo src="/img/mstile-150x150.png"/>
6+
<TileColor>#ffffff</TileColor>
7+
</tile>
8+
</msapplication>
9+
</browserconfig>

favicon.ico

14.7 KB
Binary file not shown.

img/android-chrome-192x192.png

4.12 KB
Loading

img/android-chrome-256x256.png

6.8 KB
Loading

img/apple-touch-icon.png

2.76 KB
Loading

img/coderdojo.png

5.01 KB
Loading

0 commit comments

Comments
 (0)