Cinny

<p> <a href="https://github.com/ajbura/cinny/releases"> <img alt="GitHub 发布下载量" src="https://img.shields.io/github/downloads/ajbura/cinny/total?logo=github&style=social"></a> <a href="https://hub.docker.com/r/ajbura/cinny"> <img alt="DockerHub 下载量" src="https://img.shields.io/docker/pulls/ajbura/cinny?logo=docker&style=social"></a> <a href="https://fosstodon.org/@cinnyapp"> <img alt="在 Mastodon 上关注" src="https://img.shields.io/mastodon/follow/106845779685925461?domain=https%3A%2F%2Ffosstodon.org&logo=mastodon&style=social"></a> <a href="https://twitter.com/intent/follow?screen_name=cinnyapp"> <img alt="在 Twitter 上关注" src="https://img.shields.io/twitter/follow/cinnyapp?logo=twitter&style=social"></a> <a href="https://cinny.in/#sponsor"> <img alt="赞助 Cinny" src="https://img.shields.io/opencollective/all/cinny?logo=opencollective&style=social"></a> </p>

Cinny 是一个主要专注于简单、优雅和安全界面的 Matrix 客户端。其主要目标是打造一个对用户友好且具有现代感的即时通讯应用。

• 路线图
• 贡献指南

<img align="center" src="https://yellow-cdn.veclightyear.com/835a84d5/a74b1172-4bc2-43ff-85ed-75b7a37b838a.png" height="380">

快速入门

• 网页应用可在 https://app.cinny.in 访问，每次新版本发布时都会更新。dev 分支持续部署在 https://dev.in，但请注意它可能存在一些问题。

• 你也可以从 cinny-desktop 仓库 下载我们的桌面应用。

• 要在自己的服务器上托管 Cinny，请从 GitHub 发布页面 下载应用的 tarball 文件。 你可以使用任何喜欢的网页服务器来提供服务，只需将 dist/ 目录复制到网站根目录即可。 要在登录、注册和探索社区页面设置默认的 Homeserver，请在选择的网站根目录中放置自定义的 config.json 文件。 你还需要设置重定向以提供资源服务。netlify 的重定向设置示例可以在 netlify.toml 中找到。如果你在设置重定向时遇到困难，也可以在 config.json 中将 hashRouter.enabled 设置为 true。 要部署在子目录中，你需要在更新 build.config.ts 中的 base 路径后自行重新构建应用。例如，如果你想部署在 https://cinny.in/app，则将 base 改为 '/app'。

• 或者，你可以直接拉取 DockerHub 镜像：

  docker pull ajbura/cinny
  

  或 ghcr 镜像：

  docker pull ghcr.io/cinnyapp/cinny:latest
  

<details> <summary>用于验证 tarball 的 PGP 公钥</summary>

-----BEGIN PGP PUBLIC KEY BLOCK-----
-----BEGIN PGP PUBLIC KEY BLOCK-----

mQGNBGJw/g0BDAC8qQeLqDMzYzfPyOmRlHVEoguVTo+eo1aVdQH2X7OELdjjBlyj
6d6c1adv/uF2g83NNMoQY7GEeHjRnXE4m8kYSaarb840pxrYUagDc0dAbJOGaCBY
FKTo7U1Kvg0vdiaRuus0pvc1NVdXSxRNQbFXBSwduD+zn66TI3HfcEHNN62FG1cE
K1jWDwLAU0P3kKmj8+CAc3h9ZklPu0k/+t5bf/LJkvdBJAUzGZpehbPL5f3u3BZ0
leZLIrR8uV7PiV5jKFahxlKR5KQHld8qQm+qVhYbUzpuMBGmh419I6UvTzxuRcvU
Frn9ttCEzV55Y+so4X2e4ZnB+5gOnNw+ecifGVdj/+UyWnqvqqDvLrEjjK890nLb
Pil4siecNMEpiwAN6WSmKpWaCwQAHEGDVeZCc/kT0iYfj5FBcsTVqWiO6eaxkUlm
jnulqWqRrlB8CJQQvih/g//uSEBdzIibo+ro+3Jpe120U/XVUH62i9HoRQEm6ADG
4zS5hIq4xyA8fL8AEQEAAbQdQ2lubnlBcHAgPGNpbm55YXBwQGdtYWlsLmNvbT6J
AdQEEwEIAD4CGwMFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AWIQSRri2MHidaaZv+
vvuUMwx6UK/M8wUCZqEDwAUJFvwIswAKCRCUMwx6UK/M877qC/4lxXOQIoWnLLkK
YiRCTkGsH6NdxgeYr6wpXT4xuQ45ZxCytwHpOGQmO/5up5961TxWW8D1frRIJHjj
AZGoRCL3EKEuY8nt3D99fpf3DvZrs1uoVAhiyn737hRlZAg+QsJheeGCmdSJ0hX5
Yud8SE+9zxLS1+CEjMrsUd/RGre/phme+wNXfaHfREAC9ewolgVChPIbMxG2f+vs
K8Xv52BFng7ta9fgsl1XuOjpuaSbQv6g+4ONk/lxKF0SmnhEGM3dmIYPONxW47Yf
atnIjRra/YhPTNwrNBGMmG4IFKaOsMbjW/eakjWTWOVKKJNBMoDdRcYYWIMCpLy8
AQUrMtQEsHSnqCwrw818S5A6rrhcfVGk36RGm0nOy6LS5g5jmqaYsvbCcBGY9B2c
SUAVNm17oo7TtEajk8hcSXoZod1t++pyjcVKEmSn3nFK7v5m3V+cPhNTxZMK459P
3x1Ucqj/kTqrxKw6s2Uknuk0ajmw0ljV+BQwgL6maguo9BKgCNW5AY0EYnD+DQEM
ANOu/d6ZMF8bW+Df9RDCUQKytbaZfa+ZbIHBus7whCD/SQMOhPKntv3HX7SmMCs+
5i27kJMu4YN623JCS7hdCoXVO1R5kXCEcneW/rPBMDutaM472YvIWMIqK9Wwl5+0
Piu2N+uTkKhe9uS2u7eN+Khef3d7xfjGRxoppM+xI9dZO+jhYiy8LuC0oBohTjJq
QPqfGDpowBwRkkOsGz/XVcesJ1Pzg4bKivTS9kZjZSyT9RRSY8As0sVUN57AwYul
s1+eh00n/tVpi2Jj9pCm7S0csSXvXj8v2OTdK1jt4YjpzR0/rwh4+/xlOjDjZEqH
vMPhpzpbgnwkxZ3X8BFne9dJ3maC5zQ3LAeCP5m1W0hXzagYhfyjo74slJgD1O8c
LDf2Oxc5MyM8Y/UK497zfqSPfgT3NhQmhHzk83DjXw3I6Z3A3U+Jp61w0eBRI1nx
H1UIG+gldcAKUTcfwL0lghoT3nmi9JAbvek0Smhz00Bbo8/dx8vwQRxDUxlt7Exx
NwARAQABiQG8BBgBCAAmAhsMFiEEka4tjB4nWmmb/r77lDMMelCvzPMFAmahA9IF
CRb8CMUACgkQlDMMelCvzPPQgQv/d5/z+fxgKqgfhQX+V49X4WgTVxZ/CzztDoJ1
XAq1dzTNEy8AFguXIo6eVXPSpMxec7ZreN3+UPQBnCf3eR5YxWNYOYKmk0G4E8D2
KGUJept7TSA42/8N2ov6tToXFg4CgzKZj0fYLwgutly7K8eiWmSU6ptaO8aEQBHB
gTGIOO3h6vJMGVycmoeRnHjv4wV84YWSVFSoJ7cY0he4Z9UznJBbE/KHZjrkXsPo
N+Gg5lDuOP5xjKzM5SogV9lhxBAhMWAg3URUF15yruZBiA8uV1FOK8sal/9C1G7V
M6ygA6uOZqXlZtcdA94RoSsW2pZ9eLVPsxz2B3Zko7tu11MpNP/wYmfGTI3KxZBj
n/eodvwjJSgHpGOFSmbNzvPJo3to5nNlp7wH1KxIMc6Uuu9hgfDfwkFZgV2bnFIa
Q6gyF548Ub48z7Dz83+WwLgbX19ve4oZx+dqSdczP6ILHRQomtrzrkkP2LU52oI5
mxFo+ioe/ABCufSmyqFye0psX3Sp
=WtqZ
-----END PGP PUBLIC KEY BLOCK-----
## 本地开发
> 我们建议使用版本管理器，因为版本变化非常快。根据不同项目的需求，您可能需要在多个Node.js版本之间切换。在Windows上使用[NVM for Windows](https://github.com/coreybutler/nvm-windows#installation--upgrades)，在Linux/macOS上使用[nvm](https://github.com/nvm-sh/nvm)是不错的选择。推荐的Node.js版本是Iron LTS（v20）。

执行以下命令启动开发服务器：
```sh
npm ci # 安装所有依赖
npm start # 启动开发版本服务

构建应用程序：

npm run build # 将应用程序编译到dist/目录

使用Docker运行

本仓库包含一个Dockerfile，它从源代码构建应用程序并使用Nginx在80端口上提供服务。要在本地使用，您可以按如下方式构建容器：

docker build -t cinny:latest .

然后，您可以使用类似以下的命令运行已构建的容器：

docker run -p 8080:80 cinny:latest

这将把您的localhost的8080端口转发到容器的80端口。您可以通过在浏览器中访问http://localhost:8080来使用该应用程序。