Cely 项目启动与配置教程

Cely 项目启动与配置教程

Cely Plug-n-Play login system for iOS written in Swift 项目地址: https://gitcode.com/gh_mirrors/ce/Cely

1. 项目目录结构及介绍

Cely 项目的主要目录结构如下所示：

Cely/
├── Cely.xcodeproj
├── Cely.xcworkspace
├── Images/
├── Sources/
│   ├── User.swift
│   └── ...
├── Tests/
├── fastlane/
├── scripts/
├── .gitignore
├── .swift-version
├── .swiftlint.yml
├── CODE_OF_CONDUCT.md
├── Cely.podspec
├── DEPLOY_STEPS.md
├── LICENSE
├── README.md

• Cely.xcodeproj: Xcode 项目文件，用于打开和编辑项目。
• Cely.xcworkspace: Xcode 工作区文件，用于管理项目中的多个 scheme 和 target。
• Images/: 存放项目所需的图片资源。
• Sources/: 包含所有 Swift 源代码文件，例如 User.swift 用户模型。
• Tests/: 包含单元测试代码。
• fastlane/: 存放用于自动化构建、测试和发布的 Fastlane 配置文件。
• scripts/: 包含项目构建或开发过程中可能需要的脚本。
• .gitignore: 指定 Git 忽略的文件和目录。
• .swift-version: 指定项目使用的 Swift 版本。
• .swiftlint.yml: SwiftLint 配置文件，用于代码风格检查。
• CODE_OF_CONDUCT.md: 项目行为准则文件。
• Cely.podspec: 如果项目是作为 CocoaPods 包发布的，这是 pod 的描述文件。
• DEPLOY_STEPS.md: 部署项目的步骤文档。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件，包含了项目的简介、安装和使用指南。

2. 项目的启动文件介绍

项目的启动文件是 AppDelegate.swift。该文件负责在应用启动时进行初始化设置。下面是启动文件的基本结构：

import UIKit
import Cely

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    var window: UIWindow?

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // 初始化 Cely
        Cely.setup(with: self.window, forModel: User(), requiredProperties: [.token])
        // 其他启动配置
        return true
    }
}

在这里，AppDelegate 类实现了 UIApplicationDelegate 协议，并在 didFinishLaunchingWithOptions 方法中调用了 Cely 的 setup 方法，这将会配置 Cely 的基本设置。

3. 项目的配置文件介绍

项目的配置主要通过 CelyOptions 来实现。你可以在 AppDelegate 中的 setup 方法里传递一个配置字典。以下是一些常用的配置项：

Cely.setup(
    with: self.window,
    forModel: User(),
    requiredProperties: [.token],
    withOptions: [
        .loginCompletionBlock: { (username, password) in
            // 处理登录逻辑
        },
        .loginStyle: CustomLoginStyle(),
        .celyAnimator: CustomAnimator(),
        .loginStoryboard: UIStoryboard(name: "MyCustomLogin", bundle: nil),
        .homeStoryboard: UIStoryboard(name: "NonMain", bundle: nil)
    ]
)

• .loginCompletionBlock: 处理用户登录信息的闭包。
• .loginStyle: 自定义登录界面的样式。
• .celyAnimator: 自定义登录和登出时的动画。
• .loginStoryboard: 使用自定义的登录界面故事板。
• .homeStoryboard: 指定主界面的故事板。

这些配置项可以帮助你定制化 Cely 的行为和外观，以适应你的应用需求。

Cely Plug-n-Play login system for iOS written in Swift 项目地址: https://gitcode.com/gh_mirrors/ce/Cely