Skip to content

Latest commit

 

History

History
23 lines (17 loc) · 1.59 KB

README.md

File metadata and controls

23 lines (17 loc) · 1.59 KB

MagicApp

This repository contains the platform independent smartphone application of the MagicMirror³ project.

This application allows you to customize your layout and add new users to your MagicMirror.

General information

The app is developed entirely with Flutter and Dart and contains no platform specific code.

Currently, the app can only be installed manually by cloning this repository and building and installing directly on your connected smartphone. Publishing it to the stores is definitely one of the next steps.

How to install

  1. Download and setup the latest version of Flutter simply by following this tutorial
  2. Clone this repository
  3. Open the project in your IDE of choice. We mainly use IntelliJ, but anything supporting Flutter projects is fine. In case you also want to use IntelliJ, we definitely recommend installing the Flutter, Dart, Flutter Intl and Flutter Enhancement Suite Plugins.
  4. Install all packages by opening the project in a terminal and run the command flutter pub get
    1. The overridden dependency is due to an issue of a dependency introduced by upgrading to Flutter 3.0
  5. Run the file main.dart either in an emulator or directly on your connected device

Documentation

The documentation currently only consists of code comments, but we plan to extend this via GitHub wikis or other 3rd party tools.

How to contribute

Check out our Contribution guidelines if you want to contribute to the project