AMI for iOS application

This is the iOS application for https://github.com/numerique-gouv/ami-notifications-api

Description

AMI Xcode project uses several tools:

• XcodeGen to generate Xcode project: https://github.com/yonaskolb/XcodeGen
• SwiftFormat to format Swift code: https://github.com/nicklockwood/SwiftFormat
• SwiftLint to lint Swift code: https://github.com/realm/SwiftLint
• SwiftGen to automatically generate Swift resources properies/methods: https://github.com/SwiftGen/SwiftGen

Xcode project file .xcodeproj is not gitted to avoid a lot of conflicts when working in team on the project. It is generated using xcodegen tool.

The project is described using 2 files:

• the Xcode project: ami-project.yml
• the Xcode targets: ami-targets.yml

Start with the project

1. First, clone the project, use git clone command:

   git clone git@github.com:numerique-gouv/ami-app-ios.git

2. Then configure your environnement, execute the script:

   scripts/ami-configure-build-tools.sh

3. Then, generate the Xcode project using script:

   scripts/ami-generate-xcode.sh

4. Now, you can open the generated AMI-xcodegen.xcodeproj in Xcode.

   xed AMI-xcodegen.xcodeproj

Information

• SwiftGenPlugin (used by AmiDesignSystem) must be authorized to build the project.

• SwiftGen is used in Xcode pre-build script to automatically generate Swift code (in AMI/Sources/Generated folder) for String, Color and Image resources.

  • Strings

    • SwiftGen handle strings localization automatically
    • AMIL10n.<String ID> for String and AMIL10n.StringNameID(param) for String with parameters.

  • Colors

    • SwiftGen handle Light, Dark and High constrast modes automatically
    • Asset.Color.<color ID> for a UIColor, Asset.Color.<color ID>.swiftUIColor for a SwiftUI Color

  • Images

    • Asset.Image.<image ID> for a UIImage, Asset.Image.<image ID>.swiftUIImage for a SwiftUI Image