Mayumi-Nakabayashi / withTone

2 stars 0 forks source link

withtone

音楽ソーシャル学習プラットフォーム

サポートプラットフォーム

ios, android のモバイル端末. どこまでのバージョンをサポートするかは話し合ってません.

Google Play ストア, App Store での配布を準備中です.

iPad のようなタブレットは現状対応しません (対応したいが後回し). web も現状対応しません.

開発

開発ツール

以下のツールを利用します. ★ のついたツールは招待必須なので, まだの方はメンバーに声をかけて加入してください.

開発にあたって, 言語やパッケージのバージョンを揃えます.

名前 バージョン 備考
Flutter 3.10.6 fvm などで バージョンを合わせる
各種 pub パッケージ pubspec.yaml で管理, pubspec.lock でメンバー全員のバージョンを固定. 定期的に最新版にアップデートする パッケージのインストールは flutter pub get を実行する

参考までに, ken-ty の flutter doctor の結果

$ flutter doctor
Doctor summary (to see all details, run flutter doctor -v):
[✓] Flutter (Channel stable, 3.10.6, on macOS 12.6 21G115 darwin-x64, locale ja-JP)
[✓] Android toolchain - develop for Android devices (Android SDK version 33.0.0)
[✓] Xcode - develop for iOS and macOS (Xcode 14.2)
[✓] Chrome - develop for the web
[✓] Android Studio (version 2021.3)
[✓] VS Code (version 1.81.1)
[✓] Connected device (2 available)
[✓] Network resources

アーキテクチャ

バックエンドは Firebase, アプリは Flutter で開発. ディレクトリ構成などはまだ決まってない. 状態管理は Riverpod を利用する.

ブランチ運用

git-flow を採用する. 一旦頻出するブランチのみ列挙する.

ブランチ名 役割
main 本番環境と同じ. このブランチでは作業しない.
develop 開発用ブランチ. このブランチでは作業しない.
feature 作業ブランチ. develop から分岐し, develop にマージする.

commit message

commit message の書き方をある程度揃え, レビューの負荷軽減を図る.

Angular の規約 に則ったフォーマットで, prefix は commitizen に従う. 頻出する prefix は以下.

feat:     新機能
fix:      バグ修正
docs:     ドキュメントのみの変更
refactor: リファクタリングのための変更(機能追加やバグ修正を含まない)
chore:    その他の変更(ソースやテストの変更を含まない)

git log で過去の commit message を参考にしたり, commit message で TTNE する方法 を参考にしてください.

便利なコマンド集

コマンド できること
open ios/Runner.xcworkspace/ Runner を Xcode で起動する

これから join する / したい あなたへ

withTone は随時メンバーを募集してます! 興味のある方はメンバーに「参加したい!」と声を掛けてください。

楽しく開発しましょう!!