← Back to Grouper/FlatUIKit

How to Deploy & Use Grouper/FlatUIKit

FlatUIKit Deployment and Usage Guide

1. Prerequisites

  • Xcode: Version 8.0 or later (required for iOS development)
  • iOS SDK: iOS 8.0 or later
  • CocoaPods: Required for dependency management
  • MacOS: Required for iOS development environment

2. Installation

Using CocoaPods (Recommended)

  1. Install CocoaPods if not already installed:
sudo gem install cocoapods
  1. Create a Podfile in your project directory:
platform :ios, '8.0'
pod 'FlatUIKit'
  1. Install the pod:
pod install
  1. Open the generated .xcworkspace file in Xcode.

Manual Installation

  1. Clone the repository:
git clone https://github.com/Grouper/FlatUIKit.git
  1. Drag the FlatUIKit folder into your Xcode project.

  2. Ensure the following frameworks are added to your project:

    • QuartzCore.framework
    • CoreGraphics.framework

3. Configuration

FlatUIKit does not require additional configuration files or API keys. Simply import the necessary headers in your code:

#import "FUIButton.h"
#import "FUITextField.h"
#import "FUISwitch.h"
// etc.

4. Build & Run

Development

  1. Open your project in Xcode.
  2. Select your target device or simulator.
  3. Build and run the project (⌘+R).

Production

  1. Ensure your project settings are configured for distribution.
  2. Archive your project (Product → Archive).
  3. Validate and distribute through Xcode Organizer.

5. Deployment

FlatUIKit is a UI component library for iOS applications. Deployment involves:

  1. App Store Distribution: Package your app using Xcode's Archive feature and submit to the App Store.
  2. Enterprise Distribution: Use Xcode's distribution options for enterprise apps.
  3. Ad-hoc Distribution: Distribute to specific devices for testing.

Ensure your app complies with Apple's App Store Review Guidelines when using FlatUIKit components.

6. Troubleshooting

Common Issues

Issue: "Unable to find a specification for FlatUIKit"

Solution: Ensure your CocoaPods installation is up to date:

pod repo update
pod install

Issue: Build errors related to missing frameworks

Solution: Verify that QuartzCore.framework and CoreGraphics.framework are added to your project's "Link Binary With Libraries" build phase.

Issue: UI components not displaying correctly

Solution: Ensure you're using the correct import statements and that your deployment target is set to iOS 8.0 or later.

Getting Help

  • Check the GitHub Issues page for known issues
  • Review the source code in the FlatUIKit folder for implementation examples
  • Consult Apple's Human Interface Guidelines for iOS design best practices