Installation Guide

Complete step-by-step installation instructions

Prerequisites

Before starting the installation, ensure you have the following tools installed on your system:

Flutter SDK

Minimum: 3.24.0
Recommended: 3.38.0+

Installation Guide →

Node.js

Minimum: 18.x
Recommended: 22.x LTS

Download →

Firebase CLI

Minimum: 13.0.0
Recommended: Latest

Installation Guide →

Git

Version control system

Download →

Platform-Specific Requirements

Platform Requirements
macOS
  • Xcode 14.0+ (for iOS development)
  • CocoaPods
  • Android Studio (for Android development)
Windows
  • Android Studio with Android SDK
  • Visual Studio (for Windows desktop)
Linux
  • Android Studio with Android SDK
  • Chrome (for web development)

Step 1: Extract the Package

After purchasing from CodeCanyon, download and extract the package:

# Extract the downloaded ZIP file
unzip missao-v1.0.0.zip -d ~/projects/

# Navigate to the project directory
cd ~/projects/missao

Project Structure Overview

missao/
├── lib/                      # Main Flutter application source
│   ├── admin_features/       # Admin panel features
│   ├── features/             # Mobile app features
│   ├── app/                  # App configuration & DI
│   ├── core/                 # Shared utilities
│   └── shared/               # Shared components
├── packages/
│   └── possas_ds/            # Design System package
├── functions/                # Firebase Cloud Functions
├── test/                     # Unit and widget tests
├── android/                  # Android platform files
├── ios/                      # iOS platform files
├── web/                      # Web platform files
├── documentation-envato/     # This documentation
└── firebase.json             # Firebase configuration

Step 2: Verify Flutter Installation

Run Flutter doctor to check your setup:

flutter doctor -v

You should see green checkmarks for at least:

Troubleshooting: If you see issues, follow the suggestions provided by flutter doctor or consult the Flutter installation guide.

Step 3: Install Dependencies

Main Application

# Navigate to project root (if not already there)
cd ~/projects/missao

# Get Flutter dependencies
flutter pub get

Design System Package

# Navigate to the Design System package
cd packages/possas_ds

# Get dependencies
flutter pub get

# Return to project root
cd ../..

Cloud Functions

# Navigate to functions directory
cd functions

# Install Node.js dependencies
npm install

# Return to project root
cd ..
Note: If you encounter dependency issues, try running flutter clean followed by flutter pub get.

Step 4: Configure Firebase

Before running the app, you need to set up Firebase:

Install Firebase CLI & FlutterFire

# Install Firebase CLI (if not installed)
npm install -g firebase-tools

# Login to Firebase
firebase login

# Install FlutterFire CLI
dart pub global activate flutterfire_cli

Configure Your Firebase Project

# Run FlutterFire configuration
flutterfire configure --project=YOUR_PROJECT_ID

This command will:

For detailed Firebase setup, see Firebase Setup Guide.

Step 5: Configure Environment

Create environment files for development and production:

# Copy the example environment file
cp .env.example .env.dev
cp .env.example .env.prod

Edit .env.dev with your development credentials:

# .env.dev
FLAVOR=dev
APP_NAME=Missão Dev

# Firebase (from firebase_options.dart)
FIREBASE_API_KEY=your_api_key
FIREBASE_APP_ID=your_app_id
FIREBASE_PROJECT_ID=your_project_id

# Google Maps
GOOGLE_MAPS_API_KEY_ANDROID=your_android_key
GOOGLE_MAPS_API_KEY_IOS=your_ios_key

# Features
USE_FIREBASE_EMULATORS=true
ENABLE_DEBUG_LOGS=true

For detailed configuration options, see Configuration Guide.

Step 6: Run the Application

Run on Mobile (Development)

# List available devices
flutter devices

# Run on a connected device or emulator
flutter run --dart-define-from-file=.env.dev

Run on Web (Admin Panel)

# Run the web version
flutter run -d chrome --dart-define-from-file=.env.dev

Run with Firebase Emulators (Recommended for Development)

# Start Firebase emulators in a separate terminal
firebase emulators:start

# In another terminal, run the app
flutter run --dart-define-from-file=.env.dev
Success! If everything is configured correctly, you should see the app running on your device or browser.

Step 7: Verify Installation

To verify the installation is complete:

Run Tests

# Run all tests
flutter test

# Run tests with coverage
flutter test --coverage

Build Check

# Check Android build
flutter build apk --debug

# Check iOS build (macOS only)
flutter build ios --debug --no-codesign

# Check Web build
flutter build web

Troubleshooting

Dependency Resolution Issues

flutter clean
flutter pub get

CocoaPods Issues (iOS)

cd ios
pod deintegrate
pod install --repo-update
cd ..

Gradle Issues (Android)

cd android
./gradlew clean
cd ..
flutter run

Firebase Configuration Issues

# Reconfigure Firebase
flutterfire configure --project=YOUR_PROJECT_ID --yes

Next Steps

Now that you have the application installed, proceed with:

  1. Firebase Setup - Configure your Firebase backend
  2. Configuration - Set up environment variables and API keys
  3. Customization - Customize branding and features
  4. Deployment - Deploy to production