Skip to content

jankratochvilcz/kotobaten-flutter

Repository files navigation

Kotobaten (Flutter frontend)

Kotobaten is a cross-platform Japanese flashcards app. It is written in Flutter and currently targets Android, Web, and Windows, with macOS and iOS coming soon. The client app is powered by a (not yet open-sourced) ASP .NET Core hosted on Microsoft Azure.

Developing

After pulling the codebase and installing Flutter, install the VS Code extensions for Dart & Flutter. They will automatically make sure that you have packages pulled and provide UI for running the code.

CLI

The project makes use of freezed, so you need to run flutter pub run build_runner build whenever you make changes to files that take advantage of freezed.

iOS logo generation happens via flutter_launcher_icons. Run flutter pub run flutter_launcher_icons:main to generate the icons.

Releasing

Releases are fully automated for Web, Android, and Windows via GitHub actions and Git tag-based releases. Pushing a new tag in the format vX.X.X+X wil kick off GitHub actions that build and push packages to individual platforms' stores.

git tag v2.0.5+5
git push origin --tags

For quick reference, you can delete tags using the below commands.

git tag -d v2.0.5+5
git push --delete origin v2.0.5+5

iOS

iOS releases are a manual affair for now. See steps here.