ひまわりプロジェクト

環境構築

wiki で、kubernetes 環境を整えた後、

$ skaffold dev

で動きます。

ローカル開発環境

skaffoldの場合

URL 一覧

	URL	備考
アプリケーション URL	https://himawari.dev
API リファレンス	https://himawari.dev/swagger/
API リファレンス(JSON 形式)	https://himawari.dev/swagger-json/
phpmyadmin	https://himawari-phpmyadmin.dev	username: root, password: root

基本コマンド

種類	コマンド	実行場所	効果
	skaffold dev	/	ローカル開発のサーバーを動かす
	skaffold delete	/	ローカル開発のサーバーを消す（失敗することもある）

make 系統の重要コマンド:star::star:

種類	コマンド	実行場所	効果
	make codegen	/	フロントエンド用の API リクエストコードを自動生成する。/client/openapiディレクトリにコードが生成されます。
	make create-secrets	/	ローカル開発用の環境変数をセットする
	make delete-secrets	/	ローカル開発用の環境変数を削除する(このあとmake create-secretsすることで上書きできる)
client	make client-setup	/	client 系コマンドのセットアップ(npm install するだけ)
api	make api-setup	/	api 系コマンドのセットアップ(npm install するだけ)

make 系統のその他コマンド:star::star:

種類	コマンド	実行場所	効果
client	make client-format	/	フロントエンドのコードフォーマット
〃	make client-lint	/	フロントエンドのコードの文法チェック
〃	make client-test	/	フロントエンドのテスト
〃	make client-test-container	/	フロントエンドのテストをコンテナ内部で実行する(基本使わない)
api	make api-format	/	バックエンドのコードフォーマット
〃	make api-lint	/	バックエンドのコードの文法チェック
〃	make api-test	/	バックエンドのテスト
〃	make api-test-container	/	バックエンドのテストをコンテナ内部で実行する(基本使わない)

実行場所の/は、プロジェクトルートディレクトリの意味

docker-composeの場合

URL 一覧

docker-toolbox の人は、localhost のところが192.168.99.100のはずです

	URL	備考
アプリケーション URL	http://localhost:3000
API リファレンス	http://localhost:3001/swagger/
API リファレンス(JSON 形式)	http://localhost:3001/swagger-json/
phpmyadmin	http://localhost:8888	username: root, password: root

基本コマンド

種類	コマンド	実行場所	効果
	docker-compose up	/	ローカル開発のサーバーを動かす
	docker-compose up -d	/	ローカル開発のサーバーをバックグラウンドで動かす
	docker-compose down	/	ローカル開発のサーバーを止める
	make codegen-dc	/	フロントエンド用の API リクエストコードを自動生成する。/client/openapiディレクトリにコードが生成されます。

client ディレクトリ系

まず、下記のコマンドで client コンテナに入ります

$ docker-compose exec client sh

そうすると、client コンテナ（仮想環境）の中に ssh で入ってる感じになるので、そこで下記のコマンドを実行できる

種類	コマンド	実行場所	効果
client	npm run lintfix	/	フロントエンドのコードフォーマット
〃	npm run lint	/	フロントエンドのコードの文法チェック
〃	npm run test	/	フロントエンドのテスト

api ディレクトリ系

まず、下記のコマンドで api コンテナに入ります

$ docker-compose exec api sh

そうすると、api コンテナ（仮想環境）の中に ssh で入ってる感じになるので、そこで下記のコマンドを実行できる

種類	コマンド	実行場所	効果
api	npm run format	/	バックエンドのコードフォーマット
〃	npm run lint	/	バックエンドのコードの文法チェック
〃	npm run test	/	バックエンドのテスト

プロダクション環境

URL 一覧

	URL	備考
アプリケーション URL	https://himawarigumi.xyz

インフラ構成図(doing)