# NebulaAPP

**Repository Path**: GMGood/nebula-app

## Basic Information

- **Project Name**: NebulaAPP
- **Description**: No description available
- **Primary Language**: JavaScript
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-02
- **Last Updated**: 2026-03-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Nebula App

一条龙基于 Flutter 构建的现代化跨平台（iOS, Android, Web, Desktop）应用基座。

## 🚀 功能特性

- **跨平台支持**：一套代码运行在 iOS、Android、Web 及所有桌面端（macOS, Windows, Linux）。
- **现代化设计**：遵循 **Material Design 3** 规范，内置响应式布局支持。
- **高性能架构**：采用 **Clean Architecture** 分层模型，确保代码的高内聚、低耦合。
- **状态管理**：使用 **Riverpod** 进行强类型的依赖注入与状态流转。
- **网络层封装**：基于 **Dio** 构建，支持全局拦截器（日志、身份鉴权、错误处理）。
- **安全存储**：集成 **Flutter Secure Storage**，确保敏感信息（如 Token）加密存储。
- **工程化支持**：内置统一的日志系统（Logger）、环境配置（Env）及代码规范分析。

## 🛠 技术栈

| 模块 | 技术实现 |
| :--- | :--- |
| **基础开发自** | Flutter SDK (>= 3.10.0), Dart |
| **状态管理** | [Riverpod](https://riverpod.dev/) |
| **路由导航** | [GoRouter](https://pub.dev/packages/go_router) |
| **网络请求** | [Dio](https://pub.dev/packages/dio) |
| **本地存储** | [Flutter Secure Storage](https://pub.dev/packages/flutter_secure_storage) |
| **日志调试** | [Logger](https://pub.dev/packages/logger) |
| **UI 规范** | Material Design 3 |

## 📦 项目结构

```text
lib/
├── app/                  # 应用层：入口、路由、全局主题
├── core/                 # 核心层：基础设施
│   ├── constants/        # 常量与外部环境配置 (Env)
│   ├── errors/           # 异常定义
│   ├── network/          # 网络层实现 (Dio, Interceptors)
│   └── utils/            # 通用工具类 (Logger, Validators)
├── features/             # 业务层：按功能模块划分
│   ├── auth/             # 身份认证模块 (Clean Architecture 示例)
│   │   ├── data/         # 数据层：Repository 实现、数据源
│   │   ├── domain/       # 领域层：Repository 接口、实体模型
│   │   ├── presentation/ # 表现层：UI (Pages)、状态控制 (State)
│   │   └── providers.dart# 依赖注入入口
│   └── ...               # 其他业务模块
├── shared/               # 共享层：通用组件与样式
│   ├── models/           # 全局通用模型 (ApiResponse 等)
│   ├── styles/           # UI 规范 (Spacing, TextStyles, Colors)
│   └── widgets/          # 高频复用小组件
└── main.dart             # 应用主入口
```

## ⚙️ 环境配置

项目通过 `--dart-define` 注入环境变量。主要参数定义在 `lib/core/constants/env.dart`：

- `API_BASE_URL`: 后端服务地址（默认: `http://localhost:8080`）
- `USE_FAKE_BACKEND`: 是否开启 Mock 数据（默认: `true`）
- `API_TIMEOUT_SECONDS`: 网络超时时间（默认: `10`s）

### 运行示例

```bash
# 开发环境 (使用假数据)
flutter run

# 生产联调 (指定后端地址)
flutter run --dart-define=API_BASE_URL=https://api.nebula.com --dart-define=USE_FAKE_BACKEND=false
```

## 📖 常用命令

### 开发与构建

```bash
# 获取依赖
flutter pub get

# 代码质量检查
flutter analyze

# 格式化代码
dart format lib/ test/

# 运行测试
flutter test

# 构建 Android APK
flutter build apk --release
```

## 🤝 贡献指南

1. **分支管理**：功能开发请切出 `feature/xxx` 分支，修复问题请使用 `fix/xxx`。
2. **提交规范**：遵循常规的 Commit Message 规范（`feat:`, `fix:`, `docs:`, `refactor:`）。
3. **代码风格**：提交前请运行 `dart format` 并通过 `flutter analyze` 检查。

## 📄 许可证

本项目基于 [MIT License](LICENSE) 开源。