Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

网易云信为您提供开源的示例项目,您可以参考本文档快速跑通示例项目,体验语聊房效果。

前提条件

在开始运行示例项目之前,请确保您已完成以下操作:

开发环境要求

不同的目标平台,开发环境要求也不同,具体如下:

  • Flutter 3.10.0 及以上版本

  • Dart 3.0.0 及以上版本

  • 如果您的目标平台是 iOS:

    • Xcode 11.0 及以上版本
    • 请确保您的项目已设置有效的开发者签名
    • macOS 操作系统
    • 11.0 及以上的 iPhone 或者 iPad 真机
  • 如果您的目标平台是 Android:

    • Android Studio 4.1 及以上版本
    • macOS 或 Windows 操作系统
    • Android 系统 5.0 及以上版本的真机
  • 安装 Flutter 和 Dart 插件

运行示例源码

  1. 克隆语聊房组件的示例项目源码仓库至您本地工程。

  2. 配置应用的 App Key。

    lib/app_config.dart 文件中配置应用的 App Key 与 App Secret

    // 请填写应用对应的AppKey,可在云信控制台的”AppKey管理“页面获取
    static const String _appKey = "your appKey";
    // 请填写应用对应的AppSecret,可在云信控制台的”AppKey管理“页面获取
    static const String _appSecret = "your sercet";
    // 如果您的AppKey为海外,填ture;如果您的AppKey为中国国内,填false
    static const bool _isOverSea = false;
    
    // 默认的BASE_URL地址仅用于跑通体验Demo,请勿用于正式产品上线。在产品上线前,请换为您自己实际的服务端地址
    static const String _baseUrl = 'https://yiyong.netease.im';
    static const String _baseUrlOversea = 'https://yiyong-sg.netease.im';
    
  3. 在工程根目录执行如下命令引入依赖。

    flutter pub get
    
  4. 编译运行。

    • iOS

      1. 打开终端,在 Podfile 所在文件夹中执行如下命令进行安装:

        pod install
        
      2. 完成安装后,通过 Xcode 打开 NEVoiceRoomExample.xcworkspace 工程。

      3. 编译并运行 Demo 工程。

    • Android

      i.在工程根目录执行如下命令:

       flutter run
      

      ii.使用 Android Studio(4.1及以上的版本)打开源码工程,单击运行即可。

  5. 选中设备直接运行,即可体验 Demo。

    建议在真机上运行,不支持模拟器调试。

注意

  • 该源码仅供开发者接入时参考,网易云信不负责源码的后续维护。若开发者计划将该源码用于生产环境,请确保发布前进行充分测试,避免发生潜在问题造成损失。
  • 该源码中提供的业务后台地址仅用于跑通示例源码,如果您需要上线正式产品,请自行编写、搭建自己的业务后台。

示例项目结构

示例代码lib目录结构说明如下:


├── app_config.dart  app配置
├── base       基础模
├── constants  常量
├── generated  字符串国际化(intl自动生成目录)
├── l10n       字符串国际化
├── main.dart  app入口 
├── model      数据模型
├── pages      页面 
├── utils      工具类
├── viewmodel  页面逻辑
└── widgets    ui组件