Palantir

项目背景

本项目于 2019 年 10 月 17 日启动，是一个兴趣驱动的技术项目，旨在打造一个桌面端的跨平台项目，涉及音视频，IM（即时通讯）方面, 与商业无关。

如有疑问, 请联系 Peter 谭金杰 [email protected]

如果你想加入我们，欢迎关注我们的微信公众号：前端巅峰

由于开源项目开发，需要购买服务器等，也需要资金成本，耗费成员精力，如果你想资助我们，可以在最下方扫码支付

所有项目说明文档在 docs 文件夹内

产品原型策划人员

视频资源提供人员

整体技术架构

开发

初次下载使用 推荐使用 npm 下载。

服务器已经部署到阿里云，我们只需要专注开发即可。

然后全局安装 nodemon 使用:

npm i nodemon -g

然后

npm i

npm run dev

npm start

访问端口号由 global.config.js 文件控制 ，可以手动更改,如果出现端口号被占用，可以使用 netstat 杀掉那条占用，也可以更换端口号

项目本身使用了 electron ，本身它依赖于 Chromium ，国内使用 cnpm 下载是最快的。

如果你下载依赖比较慢，我建议你使用 cnpm（即使你设置了淘宝镜像）

涉及到的技术

1. React
2. Electron
3. Webscoket 协议和 UDP 连接等
4. TCP 长链接
5. Node.js
6. Express 框架
7. Ant-Desgin 等 UI 框架
8. WebRTC 技术
9. Restfult 风格接口开发
10. 极致的性能优化

短期暂不加入打包和 C++ 插件等功能，因为搭建那些环境比较复杂，一步一步来。

开发流程/分支规范

1. 开发者更新代码后，切换到 dev 分支。
2. 首先 git checkout dev
3. 然后 git checkout -b develop/name 这里的name是作为开发者，你的名字的简写.

每个人对应有一个自己的分支 develop/name， 此分支作为自己独立的开发分支。

如果需要开发新功能， 请在此分枝上新建 feature 分支， 比如：

git checkout -b feature/hello-world

feature 分支开发完成完成之后， 合并到自己的 develop/name 分支。

确认无误后， 提 PR 到 dev分支.

最所有代码合并在dev分支 master分支作为正式版本的分支。

PR 规范

提交 PR 的时候， 注意带一些简要的信息提示， 比如：

• docs: 只改到了文档
• feat: 加入一个新特性
• fix: 修复一个 bug
• perf: 性能优化的修改
• refactor: 项目代码重构
• style: 格式修改，如空格、增加分号
• test: 增加遗漏的测试用例，或更正测试用例

后面会完善代码检查, 配置 commit-lint 等。

项目后期需要的环境

1. 全局安装 Redis
2. 全局安装 Visual Studio，win10 SDK（windows 系统），或者全局安装 Xcode(Mac 系统)，特殊情况可以跟我交流，可以采用第三方形式运行编译 C++ 插件
3. 全局安装 mongodb、mysql（网上寻找）
4. 全局安装 docker
5. 后期需要的再补充

项目目前的服务端代码编写完成情况

1. 登陆鉴权已经完成，使用 redis 持久化存储
2. 短视频、第一帧图片的服务器已经搭建好，等部署，同第一条
3. webRTC 视频直播代码已经准备好，等部署和项目进度推荐
4. IM 文字通讯，待完善
5. 其余中间件 UDP 链接等待完善
6. 如果你想要获取后端核心代码，那么你需要对项目提出相当的贡献，我将开源给你。否则就会以云端形式部署

目前核心的问题点

1. git 代码管理，提交代码需要提交 pull request
2. 根据原型图开发，分组分模块
3. 技术栈的学习,核心点的理解

接口文档

• restful 接口 返回 {code:0 或 1,data:xxx}
• code 为 0 即成功，1 即为失败
• data 是返回的说明

文件结构

+ config            // webpack配置文件夹
+ image             // gitHub的图片存储文件夹
- package.json      // 项目依赖说明文件夹
+ .babelrc            // babel的配置文件
+ .eslintrc.js        // eslint的配置文件
+ .prettierrc         // .prettier的配置文件
+ src                 // 源码文件夹
  + main              // 主进程代码
    - main.js         // 软件入口文件
  + renderer          // 渲染进程代码
    + App             // 主窗口
      + assets        // 资源文件夹
      + components    // 组件文件夹
      + Dva-model     // dva的model文件夹
      + ErrorBoundary // React错误边缘
      + Login         // 登陆的组件
      + Video         // 短视频组件
      + globalstyle   // 全局的样式文件
      + IM            // IM模块文件
      + App.jsx       // 根组件文件
      + routes.js     // 路由文件
      + index.html    // html模板文件
    + ...             // 如果有其它窗口就建立新的文件夹
    + utills          // 通用工具类函数文件夹
      + API           // ajax请求的封装接口文件夹
      + Pubsub        // 自定义事件类文件夹
- global.config.js    // 全局配置的开发文件

联系、赞助我们

所有一切收到的赞助金额将会用于服务器维护，持续迭代更新维护 （因为这个项目需要用到比较多的服务器）

联系我们 请关注微信公众号：前端巅峰

赞助我们 请扫码，谢谢