Skip to content

Latest commit

 

History

History
63 lines (51 loc) · 2.8 KB

INSTALL.md

File metadata and controls

63 lines (51 loc) · 2.8 KB
Raw

Installation procedure

Pre-built applications are available and utilize the cloud resources hosted by the author (myself). These are:

  1. Web version: https://astrolog.vedala.holdings
  2. Android: https://play.google.com/store/apps/details?id=com.vedalaholdings.astro_log
  3. iOS: https://appdistribution.firebase.dev/i/8c0b75f66438e0ed

It is also, however, easy to build this app for yourself so that you alone are in control of the data, unless you want to distribute your version of the app.

The program is written in Dart(Flutter) and can be compiled for Android, iOS and Web platforms. The installation requirements and steps for each platform is provided below.

Requirements

  1. Install flutter using the steps enumerated here. For this, you must be on one of the following platforms: MacOS, Windows, Linux or ChromeOS.
  2. Ensure that flutter environment is on dev channel
$ flutter channel dev
$ flutter upgrade
  1. Clone the repo
git clone https://github.com/kvedala/astro-logbook --depth 1 --branch main
  1. Install the required packages using the command:
flutter pub get
  1. Other build requirements are described in here.
  1. For authentication, the platform uses Firebase Authentication
  2. For Cloud database storage, Google Firestore. If you implement it yourself, ensure to review and setup the database security rules.
  3. Ensure to update all the config and API keys in the project as described in the links above.

Build the app

Build for Web

flutter build web --release

The build directory by default is: <repo root>/build/web. The files therein can be directly uploaded to your hosting server. The current app is hosted using FirebaseHosting.

Build for Android

flutter build apk --release

The generated APK file will be available in the folder: <repo root>/build/app/outputs/flutter-apk/app-release.apk. This file can be installed on your android device, provided you enable "Install from unknown sources" in your device.

Build for iOS

flutter build ipa --release

The generated ARCHIVE file will be available in the folder: <repo root>/build/ios/archive/Runner.xcarchive. This file can then be distributed using Apple Testflight or other means.