Skip to content

SETUP.md

Latest commit

 

History

History
134 lines (96 loc) · 3.68 KB

SETUP.md

File metadata and controls

134 lines (96 loc) · 3.68 KB

AURELIUM - Xcode Project Setup Guide

🚀 Creating the Xcode Project

Since this codebase was developed in a Linux environment, you'll need to create the Xcode project file yourself. Here's how to set it up:

Step 1: Create New Xcode Project

  1. Open Xcode 15+
  2. Select "File" → "New" → "Project"
  3. Choose "App" template for iOS
  4. Configure project:
    • Product Name: Aurelium
    • Team: Select your team (or leave as "None" for personal use)
    • Organization Identifier: com.aurelium (or your preferred identifier)
    • Interface: SwiftUI
    • Language: Swift
    • Life Cycle: SwiftUI App
    • Use Core Data: ✅ Enabled
    • Include Tests: ✅ Enabled (optional)

Step 2: Replace Default Files

Delete the default files and copy our implementation:

  1. Delete AureliumApp.swift, ContentView.swift, and Assets.xcassets
  2. Copy all files from /workspace/Aurelium/ to your Xcode project directory
  3. Ensure the file structure matches the specification

Step 3: Configure Core Data

  1. In Xcode, select your project in the navigator
  2. Go to "Build Phases" → "Compile Sources"
  3. Add the .xcdatamodeld file to your target
  4. In your PersistenceController, update the model name if needed

Step 4: Enable Capabilities

  1. Select your project → "Signing & Capabilities"
  2. Add these capabilities:
    • iCloud: Enable CloudKit, select your container
    • Face ID: For biometric authentication
    • Location: When In Use (optional, for location features)

Step 5: Add Privacy Permissions

The Info.plist already includes the necessary privacy descriptions. Verify they match your app's needs.

Step 6: Configure Build Settings

Ensure these settings are correct:

  • iOS Deployment Target: 17.0+
  • Swift Language Version: 5.9+
  • Enable Modules (C and Objective-C): Yes

Step 7: Add Frameworks

Ensure these frameworks are linked:

  • MapKit
  • CoreLocation
  • LocalAuthentication
  • CryptoKit
  • CloudKit

Step 8: Create Asset Catalog

  1. Create Assets.xcassets in your project
  2. Add color assets matching the Contents.json provided
  3. Add app icons and any custom images

Step 9: Build and Run

  1. Select an iOS device/simulator
  2. Build the project (Cmd+B)
  3. Run the app (Cmd+R)

🛠️ Troubleshooting

Common Issues:

"Cannot find module" errors

  • Ensure all files are added to the correct target
  • Check import statements

Core Data model not found

  • Verify the .xcdatamodeld file is in the target
  • Check the model name in PersistenceController

iCloud not syncing

  • Verify iCloud account is signed in
  • Check CloudKit container configuration

Face ID not working

  • Test on physical device (not simulator)
  • Ensure Face ID capability is enabled

📱 Testing the App

Once set up, you should be able to:

  1. Launch the app - See the 3-tab navigation
  2. Add locations - Tap the + button on the map
  3. Edit nodes - Tap on map pins to view/edit details
  4. Create trips - Use the Library tab
  5. Test privacy - Try Face ID locking on nodes

🎨 Design Verification

Verify the luxury design:

  • Gold accent color (#C6A667)
  • Rounded corners (12-22px)
  • SF Pro typography
  • Smooth animations
  • Obsidian/Ivory color scheme

🔧 Development Notes

  • The app uses MVVM architecture
  • All features are modular and extensible
  • Core Data models support CloudKit sync
  • Encryption handles sensitive data
  • Export/import uses ZIP bundles

📞 Support

If you encounter issues:

  1. Check the console for error messages
  2. Verify all capabilities are enabled
  3. Ensure device/simulator meets requirements
  4. Review the original specification for expected behavior

AURELIUM - Your World, Curated ✨