Install / Getting Started

Quick Log — A minimal, fast logging app focused on quick inputs

Install & build guide

This guide shows how to run Quick Log locally and how to build Android release artifacts.

Prerequisites

  • Flutter SDK 3.10.1 or higher
  • Dart 3.10.1 or higher
  • Java 17+ (for Android builds)
  • Android Studio or Android SDK (API 21+)
  • Node 18+ (for the website, not required for the app)

Clone the repository

git clone https://github.com/cmwen/quick-log-app.git
cd quick-log-app

Run locally

  1. Get dependencies: flutter pub get
  2. Run on an Android device/emulator: flutter run
flutter run

# List devices (useful when multiple are connected)
flutter devices

Build release artifacts

flutter build apk         # Android APK
flutter build appbundle   # Play Store (AAB)

Run tests

flutter test              # Run all tests
flutter test --coverage   # With coverage

Website (optional)

If you need to work on the repository website, switch to the astro/ directory and run:

cd astro
npm install
npm run dev

Need more help?

Start with GETTING_STARTED.md and QUICK_LOG_README.md.

For CI or release setup, check .github/workflows/. To report issues, use the issue tracker.