<PhatLam/>/docsVI

Install and get started

Requirements, building from source, first launch, sample data, language and troubleshooting.

CreditMateUpdated 21 Oct 2026
cài đặt

CreditMate is currently an internal development build (0.x): it is not on the App Store, not on TestFlight, and the source code lives in a private repository. This page explains how to build the app from source and what happens the first time you open it.

Requirements

  • A Mac with Xcode 27.
  • An iPhone or iPad running iOS/iPadOS 18 or later (or a matching simulator).
  • XcodeGen, installed with brew install xcodegen.

Build from source

The Xcode project file is never edited by hand. It is generated from project.yml, so every configuration change is made in that file and the project is regenerated.

xcodegen generate          # generate CreditMate.xcodeproj from project.yml
./scripts/test-kit.sh      # run the CreditMateKit package tests
xcodebuild test -scheme CreditMate \
  -destination 'platform=iOS Simulator,name=iPhone 17 Pro Max'

After generating the project, open CreditMate.xcodeproj in Xcode, select the CreditMate scheme and run. AI sources are configured inside the app; API keys are stored in the Keychain and never in the source code.

First launch

  1. Introduction. The first screen tells you in advance what to have ready: your banks, limits and statement dates.
  2. Add your first bank. Pick a bank from a catalog of about 60 Vietnamese banks and finance companies, then add a card. You only need a nickname and the last 4 digits.
  3. Try with sample data. To explore the app before entering your own figures, choose sample data. It is fictional and can be removed at any time.
  4. Face ID. The app offers to lock itself with Face ID. You can skip this and enable it later in Settings.
  5. CreditMate PIN. A separate 6-digit PIN belongs to the app and protects the app lock and the payment-details vault. It is independent of the iPhone passcode. A forgotten PIN cannot be recovered; the only option is to reset the vault. See Security and privacy.

Language

CreditMate comes in two languages: Vietnamese and English. The app follows the iPhone's preferred language list: if English appears before Vietnamese it uses English, otherwise Vietnamese. The AI assistant answers in the same language. Change the language in iOS Settings, under the app's entry.

Troubleshooting

  • The build fails with a "detritus not allowed" signing error. The project folder sits inside an iCloud-synced area (for example Desktop). Move the build output elsewhere with -derivedDataPath and --scratch-path.
  • CreditMate.xcodeproj is missing. Run xcodegen generate again.
  • The project path contains spaces. Quote the path when calling commands in the terminal.
  • UI tests hang. Use the official Xcode release instead of a beta; a beta can have a CoreSimulator version mismatch that leaves the test runner unresponsive.
  • Forgot your PIN. There is no recovery. Choose "Forgot your PIN?" on the lock screen to reset the vault; payment details stored in the vault are lost, other data is kept.
  • An API key is rejected. Check the key in the assistant settings with "Test connection".