Installation Guide

This guide will help you install all required tools and dependencies to develop and run the Viax platform.

System Requirements

Windows
macOS
Linux

Minimum:

Windows 10 (64-bit) or later
8 GB RAM (16 GB recommended)
10 GB free disk space
Git for Windows

Recommended:

Windows 11
16 GB RAM
SSD storage
Administrator access

Step 1: Install Flutter SDK

Download Flutter

Visit Flutter Website

Go to flutter.dev

Select Your OS

Choose your operating system (Windows, macOS, Linux)

Download SDK

Download the latest stable Flutter SDK (3.35.3 or higher)

Install Flutter

# Extract to C:\src\flutter (or your preferred location)
# Add to PATH:
# Control Panel > System > Advanced > Environment Variables
# Add: C:\src\flutter\bin

# Verify installation
flutter --version
flutter doctor

Run Flutter Doctor

flutter doctor -v

This command checks your environment and displays a report. Fix any issues marked with [!] or [X]. Expected Output:

[✓] Flutter (Channel stable, 3.35.3)
[✓] Android toolchain - develop for Android devices
[✓] Chrome - develop for the web
[✓] Android Studio (version 2023.1)
[✓] VS Code (version 1.85)
[✓] Connected device (1 available)
[✓] Network resources

Step 2: Install Android Development Tools

Android Studio

Download Android Studio

Visit developer.android.com/studio

Install

Run the installer and follow the setup wizard

Install Android SDK

Android Studio will install:

Android SDK
Android SDK Platform-Tools
Android SDK Build-Tools

Configure Flutter Plugin

Open Android Studio
Settings/Preferences > Plugins
Search “Flutter”
Install Flutter plugin (includes Dart)
Restart Android Studio

SDK Manager Configuration

Required SDK Platforms
Required SDK Tools

In Android Studio > Tools > SDK Manager > SDK Platforms:Install:

☑ Android 13.0 (API 33)
☑ Android 12.0 (API 31)
☑ Android 11.0 (API 30)

Accept Android Licenses

flutter doctor --android-licenses

Press ‘y’ to accept all licenses.

Step 3: iOS Development (macOS Only)

iOS development is only available on macOS with Xcode installed.

Install Xcode

Download Xcode

Open App Store and search for “Xcode”

Install

Download and install (this may take a while, ~15 GB)

Open Xcode

Launch Xcode to complete initial setup

Install Command Line Tools

sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer
sudo xcodebuild -runFirstLaunch

Install CocoaPods

sudo gem install cocoapods
pod setup

iOS Simulator

# Open simulator
open -a Simulator

# List available simulators
flutter emulators

# Launch specific simulator
flutter emulators --launch apple_ios_simulator

Step 4: Code Editor Setup

VS Code (Recommended)

Install VS Code

Download from code.visualstudio.com

Install Extensions

Required extensions:

Flutter (by Dart Code)
Dart (by Dart Code)

Optional but recommended:

Error Lens (inline errors)
Bracket Pair Colorizer (code readability)
GitLens (Git integration)
Material Icon Theme (file icons)

Configure Settings

Open settings (Ctrl+, or Cmd+,) and set:

{
  "editor.formatOnSave": true,
  "dart.flutterSdkPath": "C:\\src\\flutter",
  "dart.lineLength": 100,
  "editor.rulers": [80, 100],
  "files.autoSave": "afterDelay"
}

Android Studio (Alternative)

If you prefer Android Studio:

Ensure Flutter and Dart plugins are installed
File > Settings > Plugins > Install Flutter plugin
Restart Android Studio

Step 5: Install Git

Windows
macOS
Linux

Download from git-scm.com
Run installer
Use default settings or customize
Verify:

git --version

# Install via Homebrew
brew install git

# Or via Xcode Command Line Tools
xcode-select --install

# Verify
git --version

# Ubuntu/Debian
sudo apt update
sudo apt install git

# Fedora
sudo dnf install git

# Verify
git --version

Configure Git

git config --global user.name "Your Name"
git config --global user.email "[email protected]"

# Verify configuration
git config --list

Step 6: Clone Viax Repository

# Clone the repository
git clone https://github.com/Braian551/viax.git

# Navigate to project
cd viax

# Check Flutter configuration
flutter doctor

Step 7: Install Project Dependencies

Flutter Dependencies

# Install packages from pubspec.yaml
flutter pub get

# Verify dependencies
flutter pub outdated

Key Dependencies Installed:

State Management
Networking
Maps & Location
UI Components
Utilities

provider: ^6.1.3
flutter_bloc: ^9.1.1
equatable: ^2.0.5

http: ^1.1.0
dartz: ^0.10.1

flutter_map: ^8.2.2
latlong2: ^0.9.1
geolocator: ^14.0.2
geocoding: ^4.0.0

shimmer: ^3.0.0
pin_code_fields: ^8.0.1
fl_chart: ^1.1.1
image_picker: ^1.0.7

shared_preferences: ^2.2.2
intl: ^0.20.2
uuid: ^4.2.1
path_provider: ^2.1.3

Step 8: Set Up Device/Emulator

Android Emulator

Open AVD Manager

Android Studio > Tools > Device Manager

Create Virtual Device

Click “Create Device”
Select phone (e.g., Pixel 7)
Choose system image (API 33 recommended)
Configure AVD settings
Click Finish

Launch Emulator

flutter emulators
flutter emulators --launch <emulator_id>

Physical Device

Android Device
iOS Device

Enable Developer Options:
- Settings > About Phone
- Tap “Build Number” 7 times
Enable USB Debugging:
- Settings > Developer Options
- Enable “USB Debugging”
Connect via USB:
- Connect phone to computer
- Allow USB debugging on phone
- Verify:
```
flutter devices
adb devices
```

Connect iPhone/iPad:
- Connect via USB
- Trust this computer on device
Register Device:
- Open Xcode
- Window > Devices and Simulators
- Ensure device appears
Configure Signing:
- Open ios/Runner.xcworkspace in Xcode
- Select Runner target
- Signing & Capabilities
- Select your team
Verify:
```
flutter devices
```

Step 9: Verify Installation

Run Flutter Doctor

flutter doctor -v

All items should show [✓]:

[✓] Flutter (Channel stable, 3.35.3)
    • Flutter version 3.35.3
    • Framework revision xxx
    • Engine revision xxx
    • Dart version 3.8.0

[✓] Android toolchain - develop for Android devices
    • Android SDK version 33.0.0
    • Platform android-33, build-tools 33.0.0

[✓] Xcode - develop for iOS and macOS (macOS only)
    • Xcode version 15.0

[✓] Chrome - develop for the web

[✓] Android Studio (version 2023.1)
    • Flutter plugin version 77.1.1
    • Dart plugin version 231.8109.91

[✓] VS Code (version 1.85.0)
    • Flutter extension version 3.78.0

[✓] Connected device (2 available)
    • Pixel 7 (mobile) • emulator-5554
    • Chrome (web) • chrome

[✓] Network resources

Test Run

# Create test project
flutter create test_app
cd test_app

# Run on connected device
flutter run

# Should see:
# - App compiling
# - App installing on device
# - Flutter demo app launching

Run Viax

# Navigate to Viax project
cd path/to/viax

# Get dependencies
flutter pub get

# Run on device
flutter run

# Or specify device
flutter run -d <device-id>

Troubleshooting

Flutter command not found

Problem: Terminal doesn’t recognize flutter commandSolution:

Verify Flutter is in PATH:

echo $PATH  # macOS/Linux
echo %PATH%  # Windows

Add Flutter bin directory to PATH
Restart terminal
Try: flutter --version

Android licenses not accepted

Problem: flutter doctor shows Android licenses issueSolution:

flutter doctor --android-licenses
# Press 'y' for all prompts

Xcode not configured (macOS)

Problem: Xcode command line tools not foundSolution:

sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer
sudo xcodebuild -runFirstLaunch

Unable to locate Android SDK

Problem: Flutter can’t find Android SDKSolution:

Open Android Studio
Tools > SDK Manager
Note SDK location (e.g., C:\Users\YourName\AppData\Local\Android\Sdk)

Set environment variable:

export ANDROID_SDK_ROOT=/path/to/sdk  # macOS/Linux
set ANDROID_SDK_ROOT=C:\path\to\sdk  # Windows

Emulator won't start

Problem: Android Emulator fails to launchSolution:

Enable virtualization in BIOS (Intel VT-x or AMD-V)
Install HAXM:
- SDK Manager > SDK Tools > Intel x86 Emulator Accelerator
Try different system image (API 30 or 31)
Increase emulator RAM in AVD settings

CocoaPods errors (iOS)

Problem: Pod install failsSolution:

# Update CocoaPods
sudo gem install cocoapods

# Clean and reinstall
cd ios
rm -rf Pods Podfile.lock
pod install
cd ..
flutter clean
flutter pub get

Next Steps

Environment Configuration

Configure API URLs and environment variables

Local Development

Set up local backend with Laragon

Quickstart

Get the app running quickly

Architecture

Understand the codebase structure

Installation Complete! You’re now ready to develop and run Viax on your machine.

Get Started

Core Concepts

Setup & Deployment

Installation

Installation Guide

System Requirements

Step 1: Install Flutter SDK

Download Flutter

Install Flutter

Run Flutter Doctor

Step 2: Install Android Development Tools

Android Studio

SDK Manager Configuration

Accept Android Licenses

Step 3: iOS Development (macOS Only)

Install Xcode

iOS Simulator

Step 4: Code Editor Setup

VS Code (Recommended)

Android Studio (Alternative)

Step 5: Install Git

Configure Git

Step 6: Clone Viax Repository

Step 7: Install Project Dependencies

Flutter Dependencies

Step 8: Set Up Device/Emulator

Android Emulator

Physical Device

Step 9: Verify Installation

Run Flutter Doctor

Test Run

Run Viax

Troubleshooting

Next Steps

Environment Configuration

Local Development

Quickstart

Architecture

Build docs developers (and LLMs) love

Get Started

Core Concepts

Setup & Deployment

​Installation Guide

​System Requirements

​Step 1: Install Flutter SDK

​Download Flutter

​Install Flutter

​Run Flutter Doctor

​Step 2: Install Android Development Tools

​Android Studio

​SDK Manager Configuration

​Accept Android Licenses

​Step 3: iOS Development (macOS Only)

​Install Xcode

​iOS Simulator

​Step 4: Code Editor Setup

​VS Code (Recommended)

​Android Studio (Alternative)

​Step 5: Install Git

​Configure Git

​Step 6: Clone Viax Repository

​Step 7: Install Project Dependencies

​Flutter Dependencies

​Step 8: Set Up Device/Emulator

​Android Emulator

​Physical Device

​Step 9: Verify Installation

​Run Flutter Doctor

​Test Run

​Run Viax

​Troubleshooting

​Next Steps

Environment Configuration

Local Development

Quickstart

Architecture

Build docs developers (and LLMs) love

Installation Guide

System Requirements

Step 1: Install Flutter SDK

Download Flutter

Install Flutter

Run Flutter Doctor

Step 2: Install Android Development Tools

Android Studio

SDK Manager Configuration

Accept Android Licenses

Step 3: iOS Development (macOS Only)

Install Xcode

iOS Simulator

Step 4: Code Editor Setup

VS Code (Recommended)

Android Studio (Alternative)

Step 5: Install Git

Configure Git

Step 6: Clone Viax Repository

Step 7: Install Project Dependencies

Flutter Dependencies

Step 8: Set Up Device/Emulator

Android Emulator

Physical Device

Step 9: Verify Installation

Run Flutter Doctor

Test Run

Run Viax

Troubleshooting

Next Steps