README.md

兵庫県非公式 新型コロナウイルスまとめサイト

貢献の仕方

コミュニケーションについて

Slack でディスカッションを行っております。

サイト制作にご協力頂ける方であれば誰でも参加可能です。ここからご参加下さい。

コミュニケーションにあたっては、Code for Japan の 行動規範 もご確認ください。

行動原則

サイト構築にあたっての行動原則を御覧ください。

東京都オリジナルから派生した他のサイト

Link先を御覧ください。

開発者向け情報

サイト制作・開発に関する詳細はプロジェクトへの参加方法をご確認下さい。

環境構築手順

• 必要となるNode.jsのバージョン: 10.19.0以上

yarn を使う場合

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

docker compose を使う場合

# serve with hot reload at localhost:3000
$ docker-compose up --build

Vagrant を使う場合

# serve with hot reload at localhost:3000
$ vagrant up

Cannot find module **** と怒られた時

yarn を使う場合

$ yarn install

docker compose を使う場合

$ docker-compose run --rm app yarn install

本番環境/その他の判定

process.env.GENERATE_ENV の値が、本番の場合は'production'に、それ以外の場合は 'development' になっています。
テスト環境のみで実行したい処理がある場合はこちらの値をご利用ください。

CONTRIBUTORS.md への追加について

CONTRIBUTORS.md はご協力いただいた皆様を紹介するためのファイルです。

サイト制作に関わったエンジニアやデザイナーはもちろん、制作には関わらないけど貢献していただいた方々もご紹介できればと思ってます。何かしらの貢献を行った方はぜひ追記をお願いします。

追加をご希望の場合は Pull Request を送っていただくか、この Issue にコメントをお願いします。

ライセンス

本ソフトウェアは、MITライセンスの元提供されています。