yinxin630--fiora
wehub-resource-sync
64 行
3.6 KiB
Markdown
64 行
3.6 KiB
Markdown
<!-- WEHUB_ZH_README -->
|
||
> [!NOTE]
|
||
> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。
|
||
> [English](./README.en.md) · [原始项目](https://github.com/yinxin630/fiora) · [上游 README](https://github.com/yinxin630/fiora/blob/HEAD/README.md)
|
||
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
|
||
|
||
# [Fiora](https://fiora.suisuijiang.com/) · [](https://github.com/yinxin630/fiora/blob/master/LICENSE) [](http://suisuijiang.com) [](http://nodejs.org/download) [](https://github.com/yinxin630/fiora/actions?query=workflow%3A%22Unit+Test%22) [](https://github.com/yinxin630/fiora/actions?query=workflow%3A%22Typescript+Type+Check%22)
|
||
|
||
|
||
Fiora 是一款有趣的开源聊天应用。它基于 [node.js](https://nodejs.org/), [react](https://reactjs.org/) 和 [socket.io](https://socket.io/) 技术开发
|
||
|
||
- **功能丰富：** Fiora 包含后端、前端以及 Android 和 iOS 应用
|
||
- **跨平台：** Fiora 基于 node.js 开发，支持 Windows / Linux / macOS 系统
|
||
- **开源：** Fiora 遵循 MIT 开源许可证
|
||
|
||
在线示例：[https://fiora.suisuijiang.com/](https://fiora.suisuijiang.com/)
|
||
文档：[https://yinxin630.github.io/fiora/](https://yinxin630.github.io/fiora/)
|
||
|
||
**其他客户端**
|
||
Vscode 扩展：[https://github.com/moonrailgun/fiora-for-vscode](https://github.com/moonrailgun/fiora-for-vscode)
|
||
|
||
如果你在寻找类似 Discord 或 Slack 的其他开源 IM 应用，可以试试 `Tailchat`：https://tailchat.msgbyte.com/
|
||
|
||
## 功能
|
||
|
||
1. 注册账号并登录，可长期保存你的数据
|
||
2. 加入现有群组或创建自己的群组，与所有人交流
|
||
3. 与任何人私聊，并将对方添加为好友
|
||
4. 支持多种消息类型，包括文字 / 表情 / 图片 / 代码 / 文件 / 命令，还可搜索表情
|
||
5. 收到新消息时推送通知，可自定义通知铃声，还可朗读消息内容
|
||
6. 选择你喜欢的主题，可设置任意壁纸和主题色
|
||
7. 设置管理员来管理用户
|
||
|
||
## 截图
|
||
|
||
<img src="https://github.com/yinxin630/fiora/raw/master/packages/docs/static/img/screenshots/screenshot-pc.png" alt="PC" style="max-width:800px" />
|
||
<img src="https://github.com/yinxin630/fiora/raw/master/packages/docs/static/img/screenshots/screenshot-phone.png" alt="Phone" height="667" style="max-height:667px" />
|
||
<img src="https://github.com/yinxin630/fiora/raw/master/packages/docs/static/img/screenshots/screenshot-app.png" alt="App" height="896" style="max-height:896px" />
|
||
|
||
## 安装
|
||
|
||
Fiora 提供两种安装方式
|
||
|
||
- [通过源码安装](https://yinxin630.github.io/fiora/docs/install#how-to-run)
|
||
- [通过 Docker 安装](https://yinxin630.github.io/fiora/docs/install#running-on-the-docker)
|
||
|
||
## 更新日志
|
||
|
||
你可以在[网站](https://yinxin630.github.io/fiora/docs/changelog)上查看 Fiora 的更新日志
|
||
|
||
## 贡献
|
||
|
||
欢迎提交 Pull Request。对于重大变更，请先提交 issue 讨论你想修改的内容。请酌情更新测试。
|
||
|
||
1. Fork 项目（<https://github.com/yinxin630/fiora/fork>）
|
||
2. 创建功能分支（`git checkout -b some-feature`）
|
||
3. 提交更改（`git commit -am 'Add some some features'`）
|
||
4. 推送到分支（`git push origin some-feature`）
|
||
5. 创建新的 Pull Request
|
||
|
||
## 许可证
|
||
|
||
Fiora 采用 [MIT 许可证](./LICENSE)
|