WikWok 项目启动与配置教程

WikWok 项目启动与配置教程

WikWok WikWok is a beautiful and functional app that transforms your Wikipedia reading experience into an engaging, TikTok-style article feed. Learn something new with every scroll! 项目地址: https://gitcode.com/gh_mirrors/wi/WikWok

1. 项目目录结构及介绍

WikWok 是一个将 Wikipedia 阅读体验转化为 TikTok 风格文章流的应用。以下是项目的目录结构及其说明：

• .github/：存放与 GitHub Actions 相关的配置文件。
• iosApp/：包含 iOS 应用的项目文件，使用 Xcode 打开。
• metadata/：存放元数据文件，如多语言支持。
• .gitignore：定义 Git 忽略的文件和目录。
• LICENSE：Apache-2.0 许可证文件。
• PrivacyPolicy.md：隐私政策文件。
• README.MD：项目说明文件。
• build.gradle.kts：构建脚本的 Kotlin 文件。
• gradle.properties：Gradle 属性配置文件。
• gradlew：Gradle Wrapper 脚本，用于执行 Gradle 任务。
• gradlew.bat：Windows 系统下使用的 Gradle Wrapper 脚本。
• settings.gradle.kts：Gradle 设置文件。

2. 项目的启动文件介绍

启动文件主要涉及如何运行和构建应用。以下是一些关键的启动文件：

• build.gradle.kts：这是项目的主构建脚本，定义了项目依赖、构建任务和构建逻辑。
• gradlew 和 gradlew.bat：这些是 Gradle Wrapper 脚本，允许你使用项目指定的 Gradle 版本运行构建任务。

对于 Android 平台：

# 在 Android Studio 中打开项目并运行
./gradlew :composeApp:run

# 构建应用包
./gradlew :composeApp:assembleDebug

对于桌面应用：

# 运行桌面应用
./gradlew :composeApp:run

# 运行桌面应用的热重载
./gradlew :composeApp:jvmRunHot

对于 iOS 平台：

# 在 Xcode 中打开并运行
open iosApp/iosApp.xcproject

对于 Web 浏览器（Alpha）：

# 运行 Web 应用
./gradlew :composeApp:wasmJsBrowserDevelopmentRun --continue

3. 项目的配置文件介绍

配置文件主要用于定义项目依赖、构建逻辑和其他配置。

• build.gradle.kts：这是主要的构建配置文件，其中定义了项目的依赖项、插件和自定义的构建逻辑。
• gradle.properties：这个文件包含了全局的 Gradle 属性设置，例如 Gradle 守护进程的 JVM 参数。

确保在项目根目录下创建一个 local.properties 文件，并设置 Android SDK 的路径：

android.sdk_path=/path/to/your/android/sdk

以上是 WikWok 项目的启动和配置基本教程，按照这些步骤，你应该能够成功运行和调试该应用。

WikWok WikWok is a beautiful and functional app that transforms your Wikipedia reading experience into an engaging, TikTok-style article feed. Learn something new with every scroll! 项目地址: https://gitcode.com/gh_mirrors/wi/WikWok