Skip to content

Getting Started Overview

This guide will help you get started with OpenTransition development.

Prerequisites

Before you begin, ensure you have the following installed:

Required Software

  • Android Studio: Latest stable version (Hedgehog or newer recommended)
  • JDK: Java Development Kit 17
  • Git: For version control
  • Firebase Account: For development testing
  • Android Emulator: For testing without a physical device
  • ADB (Android Debug Bridge): Comes with Android Studio
  • Gradle: Included with the project

System Requirements

For Development

  • Windows 10 or later (64-bit)
  • 8 GB RAM minimum (16 GB recommended)
  • 10 GB free disk space
  • Screen resolution: 1280x800 minimum
  • macOS 10.14 (Mojave) or later
  • 8 GB RAM minimum (16 GB recommended)
  • 10 GB free disk space
  • Screen resolution: 1280x800 minimum
  • 64-bit GNU/Linux distribution
  • 8 GB RAM minimum (16 GB recommended)
  • 10 GB free disk space
  • GNOME or KDE desktop

For Running the App

  • Android Device or Emulator: Android 5.0 (API 21) or higher
  • Google Play Services: Required for Firebase features
  • Camera: Optional, for taking photos directly in the app
  • Storage Permission: For importing photos

What You'll Learn

In this getting started section, you will learn:

  1. Development Setup: How to set up your development environment, configure Firebase, and clone the repository.

  2. Building the App: How to build and run the app on an emulator or physical device, including debug and release builds.

Quick Start

If you're eager to get started quickly:

# Clone the repository
git clone https://github.com/shelbeely/OpenTransition.git
cd OpenTransition

# Copy the example secrets file
cp secrets.properties.example secrets.properties

# Edit secrets.properties with your configuration
# Download google-services.json from Firebase Console
# Place it in the mobile/ directory

# Build and run (all modules)
./gradlew build

# Or build just the mobile app
./gradlew :mobile:assembleDebug

Firebase Configuration Required

The app requires Firebase configuration to build successfully. See the Development Setup guide for detailed instructions.

Understanding the Project Structure

This is a monorepo containing three modules:

OpenTransition/
├── .github/              # GitHub workflows and configurations
│   └── workflows/        # CI/CD pipeline definitions
├── mobile/               # Main Android phone/tablet application
│   ├── src/
│   │   ├── main/        # Main source code
│   │   ├── test/        # Unit tests
│   │   └── androidTest/ # Instrumentation tests
│   └── build.gradle     # Mobile module build configuration
├── wear/                 # Wear OS companion application
│   ├── src/
│   │   └── main/        # Wear OS source code
│   └── build.gradle     # Wear module build configuration
├── shared/               # Shared library (data models, Wearable constants)
│   ├── src/
│   │   └── main/
│   └── build.gradle
├── docs/                 # Documentation source files (MkDocs)
├── gradle/               # Gradle wrapper files
├── keys/                 # Keystore files (debug committed; release gitignored)
├── build.gradle          # Root build configuration
├── settings.gradle       # Gradle module settings
├── mkdocs.yml            # Documentation configuration
└── README.md             # Project README

Module Descriptions

Module Package Min SDK Purpose
:mobile com.shelbeely.opentransition 21 (Android 5.0) Main phone/tablet app
:wear com.shelbeely.opentransition.wear 30 (Wear OS 3.0) Smartwatch companion
:shared com.shelbeely.opentransition.shared — Common models & constants

Both :mobile and :wear depend on :shared. See MONOREPO.md for communication details.

Next Steps

Ready to set up your development environment? Proceed to:

→ Development Setup

Need Help?

If you run into issues:

  1. Check the Development Setup guide for detailed instructions
  2. Search existing GitHub Issues
  3. Create a new issue if your problem isn't already reported
  4. Join the community discussions

Additional Resources