Skip to content

Commit c0d4662

Browse files
committed
Update README: Hide Docker setup + Add new usecase for API
1 parent 7111698 commit c0d4662

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ https://speakerdeck.com/yasulab/case-study-rails-cms-for-coderdojo
9595
1. ブラウザから [localhost:3000](http://localhost:3000) にアクセスします
9696
1. [coderdojo.jp](https://coderdojo.jp/) と同様のサイトが表示できれば完了です
9797

98+
<!--
9899
### :whale: Docker を利用したセットアップ方法
99100
100101
上記の他、Docker を使ったセットアップ方法もあります。[Docker](https://www.docker.com/community-edition) をインストールし、下記の手順でセットアップしてください 🛠💨
@@ -105,6 +106,7 @@ https://speakerdeck.com/yasulab/case-study-rails-cms-for-coderdojo
105106
1. ターミナルから `$ docker-compose exec rails bin/setup` を実行します
106107
1. ブラウザから [localhost:3000](http://localhost:3000) にアクセスします
107108
1. [coderdojo.jp](https://coderdojo.jp/) と同様のサイトが表示できれば完了です
109+
-->
108110

109111
### :rocket: CI/Deploy 構成
110112

@@ -114,7 +116,7 @@ https://speakerdeck.com/yasulab/case-study-rails-cms-for-coderdojo
114116
- Deploy: Heroku + [Release Phase](https://devcenter.heroku.com/ja/articles/release-phase)
115117
- 関連PR: [:octocat: replace travis with github actions and heroku integration](https://github.com/coderdojo-japan/coderdojo.jp/pull/1315)
116118

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

119121
- テスト(CI): [.github/workflows/test.yml](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/.github/workflows/test.yml)
120122
- デプロイ前: Bundle, Asset Precomiple, Heroku Buildpack など
@@ -194,6 +196,7 @@ We use `SCRIVITO_TENANT` and `SCRIVITO_API_KEY` keys in production, but they are
194196
- 利用例: [📰 DojoNews - GitHub](https://news.coderdojo.jp/category/news/) (関連PR: [coderdojo.jp#1433](https://github.com/coderdojo-japan/coderdojo.jp/pull/1433))
195197
- **Event API: https://coderdojo.jp/events.json**
196198
- 利用例: [🗾 DojoMap - GitHub](https://github.com/coderdojo-japan/map.coderdojo.jp#readme) (関連PR: [map.coderdojo.jp#10](https://github.com/coderdojo-japan/map.coderdojo.jp/pull/10))
199+
- 利用例: [📅 CoderDojo カレンダーを作ってみた](https://qiita.com/takatama/items/60276143e441c1c4f078) (関連PR: [map.coderdojo.jp#10](https://github.com/coderdojo-japan/coderdojo.jp/pull/1547))
197200

198201
なお本サイト内 DB の各テーブル情報は [`db/schema.rb`](https://github.com/coderdojo-japan/coderdojo.jp/blob/main/db/schema.rb) からご確認いただけます。
199202

0 commit comments

Comments
 (0)