diff --git a/README.md b/README.md index 14ff733edaa9356484841bf844329278c7bc26cd..8ac474d9f515841c4e22f95130aab917f177de9e 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,93 @@ -# social_median_app +# Social Median App -#### 介绍 -仿YB +## 介绍 -#### 软件架构 -软件架构说明 +Social Median App 是一个基于 Android 平台的社交应用,旨在为用户提供一个简洁、高效的社交互动体验。该应用支持用户注册、登录、发布动态、评论、关注等功能,并采用现代化的 UI 设计和架构模式。 +## 软件架构 -#### 安装教程 +Social Median App 采用以下技术栈和架构: -1. xxxx -2. xxxx -3. xxxx +- **语言**: Kotlin +- **框架**: Jetpack Compose(用于 UI 开发) +- **架构模式**: MVVM(Model-View-ViewModel) +- **网络请求**: Retrofit + OkHttp +- **数据存储**: Shared Preferences +- **状态管理**: LiveData + ViewModel +- **导航**: Jetpack Navigation Compose +- **图片上传**: Multipart 请求上传文件 -#### 使用说明 +项目结构清晰,模块化设计便于维护和扩展。 -1. xxxx -2. xxxx -3. xxxx +## 安装教程 -#### 参与贡献 +1. 确保你的开发环境已安装 Android Studio(建议使用最新版本)。 +2. 克隆项目到本地: + ```bash + git clone https://gitee.com/your-repo/social_median_app.git + ``` +3. 打开 Android Studio,选择项目目录并导入。 +4. 同步 Gradle 项目。 +5. 连接 Android 设备或启动模拟器。 +6. 点击 "Run" 按钮运行应用。 -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +## 使用说明 +### 主要功能 -#### 特技 +- **用户系统**: + - 注册与登录 + - 上传头像 + - 查看个人资料 + - 关注/取消关注其他用户 -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +- **动态发布与浏览**: + - 发布带文字和图片的动态 + - 浏览所有动态 + - 查看特定用户的动态 + - 查看关注用户的动态 + +- **评论系统**: + - 对动态进行评论 + - 查看动态的所有评论 + - 查看用户的所有评论 + +- **导航系统**: + - 底部导航栏包含首页、通知、搜索、个人中心等页面 + - 支持跳转到动态详情页、用户主页等 + +### 页面导航 + +- **首页 (Home)**: 展示所有动态列表。 +- **通知 (Notification)**: 显示通知信息。 +- **搜索 (Search)**: 搜索用户。 +- **个人中心 (Profile)**: 查看和编辑个人资料。 +- **发布动态 (Add Threads)**: 发布新的动态。 +- **登录 (Login)**: 用户登录。 +- **注册 (Register)**: 新用户注册。 +- **用户主页 (Other Users)**: 查看其他用户的资料和动态。 +- **动态详情 (Thread Detail)**: 查看动态详情及评论。 + +## 参与贡献 + +欢迎贡献代码!请遵循以下步骤: + +1. Fork 项目。 +2. 创建新分支 (`git checkout -b feature/your-feature-name`)。 +3. 提交更改 (`git commit -am 'Add some feature'`)。 +4. 推送分支 (`git push origin feature/your-feature-name`)。 +5. 提交 Pull Request。 + +## 特技 + +- **Jetpack Compose**: 使用声明式 UI 框架构建现代 Android 界面。 +- **Retrofit + OkHttp**: 高效的网络请求框架,支持同步和异步请求。 +- **Multipart 文件上传**: 支持图片上传功能。 +- **LiveData + ViewModel**: 实现响应式数据绑定和生命周期感知的数据管理。 +- **Sealed Class 状态管理**: 使用 `PostStatus` 管理 UI 状态。 +- **Shared Preferences**: 本地存储用户信息,实现自动登录功能。 +- **模块化设计**: 代码结构清晰,易于维护和扩展。 + +## 许可证 + +本项目采用 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。 \ No newline at end of file