Skip to main content

​
Prerequisites

Before you begin, ensure you have:
  • Flutter SDK (3.10.0 or later)
  • Rust (latest stable)
  • PostgreSQL (14 or later)
  • Docker (optional, for easy deployment)
The fastest way to get started: 
# Clone the repository
git clone https://github.com/olympia-hq/zeus.git
cd zeus

# Start all services
docker-compose up -d

# Run database migrations
cd server
cargo sqlx migrate run
Your server will be running at http://localhost:3000.

​
Option 2: Manual Setup

​
1. Start the Server

# Navigate to server directory
cd server

# Install dependencies
cargo build

# Set up database
createdb zeus
cargo sqlx migrate run

# Run the server
cargo run

​
2. Run the Flutter App

# Navigate to Flutter app
cd app/flutter

# Install dependencies
flutter pub get

# Run the app (iOS)
flutter run --flavor development

# Or for Android
flutter run --flavor development

​
Verify Installation

Once everything is running:
  1. Open the app on your device/simulator
  2. Create a wallet - Tap the + button to add your first wallet
  3. Add a category - Create expense/income categories
  4. Log a transaction - Record your first expense or income
The data will sync automatically when you’re online.

​
Next Steps

Architecture

Understand how Zeus works under the hood

Concepts

Learn about wallets, categories, and transactions