App Creaty 项目使用教程
1. 项目的目录结构及介绍
App Creaty 项目的目录结构如下:
app_creaty/
├── assets/
├── lib/
├── linux/
├── macos/
├── web/
├── windows/
├── .gitignore
├── LICENSE
├── README.md
├── SUPABASE_CONFIG.md
├── SUPPORTED_WIDGETS.md
├── analysis_options.yaml
├── env.example.json
├── l10n.yaml
├── mason-lock.json
├── mason.yaml
├── pubspec.lock
├── pubspec.yaml
目录结构介绍
- assets/: 存放项目所需的静态资源文件,如图片、字体等。
- lib/: 存放项目的核心代码,包括各种 Dart 文件。
- linux/: 存放 Linux 平台相关的配置和代码。
- macos/: 存放 macOS 平台相关的配置和代码。
- web/: 存放 Web 平台相关的配置和代码。
- windows/: 存放 Windows 平台相关的配置和代码。
- .gitignore: Git 忽略文件,指定哪些文件或目录不需要被 Git 管理。
- LICENSE: 项目的开源许可证文件。
- README.md: 项目的介绍文档。
- SUPABASE_CONFIG.md: Supabase 配置相关的文档。
- SUPPORTED_WIDGETS.md: 支持的 Widget 列表文档。
- analysis_options.yaml: 代码分析配置文件。
- env.example.json: 环境配置示例文件。
- l10n.yaml: 国际化配置文件。
- mason-lock.json: Mason 锁定文件。
- mason.yaml: Mason 配置文件。
- pubspec.lock: 依赖锁定文件。
- pubspec.yaml: 项目的依赖配置文件。
2. 项目的启动文件介绍
App Creaty 项目的启动文件位于 lib/
目录下。主要的启动文件是 main.dart
,该文件负责初始化应用并启动主界面。
// lib/main.dart
import 'package:flutter/material.dart';
import 'package:app_creaty/app.dart';
void main() {
runApp(AppCreatyApp());
}
启动文件介绍
- main.dart: 这是 Flutter 应用的入口文件。
main()
函数调用runApp()
方法来启动应用,并传入AppCreatyApp
作为根组件。 - app.dart: 包含
AppCreatyApp
类,定义了应用的主界面和基本配置。
3. 项目的配置文件介绍
pubspec.yaml
pubspec.yaml
是 Flutter 项目的依赖配置文件,定义了项目所需的依赖包、资源文件、版本号等信息。
name: app_creaty
description: A new Flutter project.
version: 1.0.0+1
environment:
sdk: ">=2.19.6 <3.0.0"
dependencies:
flutter:
sdk: flutter
supabase: ^1.0.0
# 其他依赖包
dev_dependencies:
flutter_test:
sdk: flutter
build_runner: ^2.1.7
# 其他开发依赖包
flutter:
uses-material-design: true
assets:
- assets/
env.example.json
env.example.json
是环境配置示例文件,包含了 Supabase 和 Sentry 的配置信息。
{
"SUPABASE_URL": "PASTE_YOUR_SUPABASE_URL",
"SUPABASE_ANON": "PASTE_YOUR_SUPABASE_ANON_KEY",
"SENTRY_DSN": "PASTE_YOUR_SENTRY_DSN"
}
SUPABASE_CONFIG.md
SUPABASE_CONFIG.md
是 Supabase 配置相关的文档,详细介绍了如何配置 Supabase 以支持项目。
SUPPORTED_WIDGETS.md
SUPPORTED_WIDGETS.md
是支持的 Widget 列表文档,列出了项目中支持的所有 Widget 及其属性。
analysis_options.yaml
analysis_options.yaml
是代码分析配置文件,定义了代码风格和静态分析规则。
include: package:flutter_lints/flutter.yaml
linter:
rules:
prefer_const_constructors: false
# 其他规则
通过以上配置文件,可以确保项目在不同环境下的一致性和可维护性。