Cupertino Clock

An analog clock that looks and feels the same as iPhone's analog clock from Standby Mode.

Installation 💻

❗ In order to start using Cupertino Clock, you must have the Flutter SDK installed on your machine.

Install via flutter pub add:

dart pub add cupertino_clock

Features 🚀

Cupertino Clock offers a Cupertino-style analog clock widget for Flutter applications. It's designed to seamlessly integrate with both iOS and Android platforms, providing a stylish and functional time display option.

Configurable Time Zones
Customizable Sizes
ONLY Dark Mode Compatibility

Continuous Integration 🤖

Cupertino Clock comes with built-in GitHub Actions workflow powered by Very Good Workflows, but you can also add your preferred CI/CD solution.

Out of the box, on each pull request and push, the CI formats, lints, and tests the code. This ensures the code remains consistent and behaves correctly as you add functionality or make changes. The project uses Very Good Analysis for a strict set of analysis options used by our team. Code coverage is enforced using Very Good Coverage.

Running Tests 🧪

For first time users, install the very_good_cli:

dart pub global activate very_good_cli

To run all unit tests:

very_good test --coverage

To view the generated coverage report you can use lcov:

# Generate Coverage Report
genhtml coverage/lcov.info -o coverage/

# Open Coverage Report
open coverage/index.html

Usage Example 📝

Here's a quick example to get you started with Cupertino Clock:

import 'package:flutter/material.dart';
import 'package:cupertino_clock/cupertino_clock.dart';

void main() {
  runApp(
    MaterialApp(
      theme: ThemeData.dark(),
      home: Scaffold(
        body: Center(
          child: CupertinoClock.round(
            size: 300,
            location: 'America/New_York',
          ),
        ),
      ),
    ),
  );
}

License 📄

Cupertino Clock is available under the MIT license. See the LICENSE file for more info.