Skip to content

kajiLabTeam/okarin

Repository files navigation

© 2026 kanakanho

全体構成

  • okarin
    • issueを管理するリポジトリ。issueと各リポジトリのPRを紐づけてアップデートを管理する
  • kaede
    • 今回のシステムの基幹リポジトリでモバイルからのデータを取得しPythonサーバーやDBとの接続などを行う
  • nozomi
    • Pythonパッケージを用いてセンサデータを処理するためのサーバー
  • rikka
    • ロジックに全集中したパッケージリポジトリ

ブランチ

999/feat-add-something イシュー番号/プレフィックス-ブランチ詳細

ローカル実行(最短)

kaede

cd apps/kaede
pnpm install
pnpm run dev

nozomi

cd apps/nozomi
uv sync --all-groups
uv run dev

HOSTPORT は環境変数で上書きできます。

HOST=0.0.0.0 PORT=8080 uv run start

コミット前チェック

このリポジトリはルートで lefthook を使います。

lefthook install

git commit 時に、kaedenozomi のチェックが両方実行されます。

kaede を手動で確認する場合:

cd apps/kaede
pnpm lint
pnpm exec prettier --check .
pnpm exec tsc --noEmit
pnpm build

nozomi を手動で確認する場合:

cd apps/nozomi
uv run ruff check .
uv run ruff format --check .
uv run mypy .
uv run pytest

CI 対応

  • apps/kaede/** を変更すると Kaede CI が実行されます(lint / format / typecheck / build / docker image build)。
  • apps/nozomi/** を変更すると Nozomi CI が実行されます(lint / format / typecheck / pytest / docker image build)。

Docker Compose 構成

  • compose.yml: 共通定義(kaede / nozomi
  • compose.local.yml: ローカル用オーバーレイ(postgres / seaweedfs 追加、ローカルビルド)
  • compose.staging.yml: staging 用オーバーレイ(環境変数ファイルを staging に切替)
  • compose.production.yml: production 用オーバーレイ(環境変数ファイルを production に切替)

ローカル起動(app + postgresql + object storage)

初回はテンプレートから実ファイルを作成:

cp env/local/common.env.example env/local/common.env
cp seaweedfs/s3.conf.example seaweedfs/s3.conf
make up ENV=local

停止:

make down ENV=local

ローカル環境変数は env/local/common.env を使います。

seaweedfs/s3.conf で S3 認証情報(accessKey / secretKey)を管理しています。
キーを変更する場合は seaweedfs/s3.confenv/local/common.env の両方を同じ値に更新してください。 これら実ファイルは .gitignore で除外されるため、GitHubには上がりません。

staging / production の環境変数

  • env/staging/common.env.exampleenv/production/common.env.example をベースに実ファイルを作成してください。
  • ENV_FILE で読み込む env ファイルを切り替えます。

staging 手動デプロイ

make up ENV=staging ENV_FILE=./env/staging/common.env

production 手動デプロイ

make up ENV=production ENV_FILE=./env/production/common.env APP_TAG=v1.0.0

停止:

make down ENV=production ENV_FILE=./env/production/common.env

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors