misskey README

The project's README from github.com/misskey-dev/misskey. As one markdown file: README.md.

Misskey logo

🌎 Misskey is an open source, federated social media platform that's free forever! 🚀

Learn more


find an instance create an instance become a contributor join the community become a patron

Ask DeepWiki

Thanks

Sentry

Thanks to Sentry for providing the error tracking platform that helps us catch unexpected errors.

Chromatic

Thanks to Chromatic for providing the visual testing platform that helps us review UI changes and catch visual regressions.

Codecov

Thanks to Codecov for providing the code coverage platform that helps us improve our test coverage.

Crowdin

Thanks to Crowdin for providing the localization platform that helps us translate Misskey into many languages.

Docker

Thanks to Docker for providing the container platform that helps us run Misskey in production.


Support us with a ⭐ !

Star History Chart

misskey (misskey-dev/misskey)

Searching Database…

11.3K ·GitHub
这是什么?Misskey 是一款开源的联邦式社交媒体(微博客)平台,基于 ActivityPub 构建,因此你自己的实例可以关注其他联邦宇宙服务器(如 Mastodon)上的账号,并与之互动。项目自称永久免费。
这是我要安装的应用,还是需要自己运行的服务器?Misskey 是服务器软件(由 TypeScript 后端和网页前端组成),你需要部署它来架设自己的联邦实例。之后,人们可以在该实例上注册,通过网页客户端使用,并与更广泛的联邦宇宙互动。
如何让自己的 Misskey 实例运行起来?你可以使用 Docker 部署 Misskey,也可以从源代码构建:先运行 pnpm compile-config,再运行 pnpm build 以编译后端、前端和资源文件,最后运行 pnpm start 启动后端(node ./built/entry.js)。
构建之前需要先安装什么?你需要安装 Node.js 和 pnpm,因为该项目是由 pnpm 管理的单体仓库(monorepo),包含后端、前端和 misskey-js 包,其构建流程使用了 esbuild 以及其他 pnpm 脚本。
自己运行实例有什么缺点?自托管意味着服务器、内容审核和日常维护都要由你自己负责。另外,Misskey 采用 AGPL-3.0 许可证,任何将修改后的版本对外公开提供服务的人,也必须公开其源代码的改动。
用 Misskey 必须自己架设服务器吗?不必。你可以在别人运营的公开 Misskey 实例上注册;如果你想完全掌控,也可以搭建自己的自托管实例。
我的实例能与 Mastodon 和其他联邦宇宙应用互通吗?可以。Misskey 实现了 ActivityPub 协议,这也是 Mastodon 和 Pleroma 所用的联邦协议,因此账号可以跨实例、跨平台关注和互动。
Misskey 支持其他语言吗?支持。项目使用 Crowdin 进行本地化,贡献者可以将界面翻译成多种语言。
项目如何保证界面和后端的质量?Misskey 使用 Codecov 跟踪测试覆盖率,使用 Chromatic 进行界面视觉回归测试,并使用 Sentry 捕获线上错误。
What are similar projects?mastodon, lemmy, owncast, PeerTube, ruflo, social-app, diaspora, forem
Size
385 MB
Stars
11.3K
Age
9y
Commits · 90 Days