Skip to content
This repository was archived by the owner on Jan 27, 2026. It is now read-only.

README.md

Latest commit

 

History

History
87 lines (59 loc) · 2.88 KB

README.md

File metadata and controls

87 lines (59 loc) · 2.88 KB

wakatime

VisualPT

VisualPT Mobile App

Getting Started

Warning

Setting up this dev environment can be a tricky process, as you will need to install various systems to run a debuggable iOS application on your machine. Any sticky errors that show up during this process should be documented and added to a New Discussion to accelerate future onboarding experiences, thank you.

Prerequisites:

Installation

Clone this repository, open the terminal, and cd to the cloned directory, then:

  • Get all the Flutter/Dart dependencies
flutter pub get
  • Get all the iOS platform-specific dependencies from inside the ios folder (remember to cd out)
cd ios && pod install && cd ..

Configuration

Before running the application, you need to set up your configuration files:

  1. Environment Variables: Copy .env.example to .env and fill in your API keys:

    cp .env.example .env

    Then edit .env with your KinesteX API key.

  2. AWS Amplify Configuration: You have two options:

    Option A - Using Amplify CLI (Recommended for new deployments):

    npx ampx sandbox --outputs-format dart --outputs-out-dir lib

    This will create amplify_outputs.json and lib/amplify_outputs.dart with your AWS resources.

    Option B - Manual configuration (For existing deployments): Copy amplify_outputs.example.json to amplify_outputs.json and fill in your AWS resource IDs:

    cp amplify_outputs.example.json amplify_outputs.json

    Then copy lib/amplify_outputs.dart.example to lib/amplify_outputs.dart and fill in the same values:

    cp lib/amplify_outputs.dart.example lib/amplify_outputs.dart

Important: Never commit .env, amplify_outputs.json, or lib/amplify_outputs.dart to version control as they contain sensitive credentials.

Build & Run

  • Create the build artifact for the iOS platform
flutter build ios
  • Run the application in debug mode (ensure your device is connected)
flutter run

Usage

VisualPT should be developed on a real device at all times, the XCode Simulator should not be used as it cannot access an on-device camera.

Architecture

See VisualPT Architecture Discussion