Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 3.15 KB

README.md

File metadata and controls

52 lines (36 loc) · 3.15 KB

Supported OSes

  • Android
  • MacOS
  • Windows

To see exactly what features are supported on each platform, please see.

Develope

IDE

  1. Install VSCode and Flutter plugin

General steps:

  1. Install Flutter framework
  2. Clone this respository
  3. Clone shared_preferences patched version: git clone --branch shared [email protected]:franciscojma86/plugins.git --depth 1. After the clone, the plugins folder should be in the same folder as this project (not inside this project). This step will no longer be needed once the PR is merged in the upstream.
  4. Copy example.env to .env in the same folder. You will need the secrets from CertainTLS backend project

Requirements for development:

  1. Read the official flutter desktop support requirements first
  2. Develop on Linux for Android: you will need an Android simulator or an actual Android device to run only Android builds.
  3. Develop on MacOS for MacOS (optionally for Android):
    1. enable flutter beta channel
    2. run flutter config --enable-macos-desktop, see more details
  4. Develop on Windows for Windows (optionally for Android):
    1. enable flutter dev channel
    2. run flutter config --enable-windows-desktop, see more details

Packaging and distribution tools:

  1. Android - see Build and release an Android app
  2. MacOS - you will also need to install Xcode to build the MacOS version of the app. There is no official flutter build documentation for MacOS yet, but you can see Build and release an iOS app, MacOS build is very similar
  3. Windows - see Windows distribution options, and you also will need MSIX Packaging Tool to make a .msix pacckage to distribute in Microsfot Store

Automated testing:

See WIKI

Cron jobs:

See WIKI (same as above, will spin off in the near future)

Support:

Please file an issue.

Code contribution:

  1. Clone this repository into your own project.
  2. Do the work
  3. Create a Pull Request against this repository. For more details, please see GitHub - Contributing to a Project