Cely 的安装和配置教程

1. 项目基础介绍和主要编程语言

Cely 是一个为 iOS 应用提供快速登录系统的开源项目。它的目标是让开发者能够在不到 30 秒的时间内集成一个完整的登录系统到应用中。Cely 在背后使用了 Locksmith，这是 Swift 语言中一个流行的 Keychain 封装库，保证了用户凭证的安全存储。

该项目主要使用 Swift 编程语言编写。

2. 项目使用的关键技术和框架

Cely 使用的关键技术包括：

• Locksmith：用于安全地存储用户凭证的 Keychain 封装库。
• Protocol-Oriented Programming (POP)：Cely 使用协议来定义用户模型和样式，提高了代码的灵活性和可重用性。
• StoryboardSegue：Cely 通过自定义的转场动画来管理登录界面和主页面的切换。

3. 项目安装和配置的准备工作及详细步骤

准备工作

在开始之前，请确保您的开发环境满足以下要求：

• Xcode 9.0 或更高版本
• iOS 11.0 或更高版本的目标设备
• Swift 4.0 或更高版本的编译器

安装步骤

步骤 1：克隆项目到本地

打开终端，运行以下命令来克隆 Cely 项目到本地：

git clone https://github.com/cely-tools/Cely.git

步骤 2：创建用户模型

在您的 Xcode 项目中，创建一个用户模型，使其遵循 CelyUser 协议。例如：

import Cely

struct User: CelyUser {
    enum Property: CelyProperty {
        case token = "token"
    }
}

步骤 3：集成 Cely

在您的 AppDelegate.swift 文件中，引入 Cely 并在 didFinishLaunchingWithOptions 方法中设置 Cely。

import Cely

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    Cely.setup(with: window!, forModel: User(), requiredProperties: [.token])
    return true
}

步骤 4：处理登录逻辑

您需要提供一个闭包来处理用户登录的逻辑。这可以在设置 Cely 时作为 loginCompletionBlock 传入。

Cely.setup(with: window!, forModel: User(), requiredProperties: [.token], withOptions: [
    .loginCompletionBlock: { (username: String, password: String) in
        // 在这里处理登录逻辑
    }
])

步骤 5：自定义登录界面（可选）

如果您想要自定义登录界面，可以创建一个遵循 CelyStyle 协议的结构体，并在设置 Cely 时传入。

struct MyCustomStyle: CelyStyle {
    func backgroundColor() -> UIColor {
        // 返回自定义背景色
    }
    // 定义其他样式属性...
}

Cely.setup(with: window!, forModel: User(), requiredProperties: [.token], withOptions: [
    .loginStyle: MyCustomStyle()
])

步骤 6：使用自定义的Storyboard（可选）

如果您想使用自己的Storyboard 作为登录界面，需要在设置 Cely 时指定。

Cely.setup(with: window!, forModel: User(), requiredProperties: [.token], withOptions: [
    .loginStoryboard: UIStoryboard(name: "MyCustomLogin", bundle: nil)
])

确保您的登录Storyboard 设置为初始视图控制器。

完成以上步骤后，您就已经成功集成了 Cely 登录系统。您可以进一步自定义和调整以适应您的应用需求。