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
What is this?Misskey is an open source, federated social media (microblogging) platform built on ActivityPub, so your own instance can follow and interact with accounts on other fediverse servers like Mastodon. The project describes itself as free forever.
Is this an app I install, or a server I run myself?Misskey is server software (a TypeScript backend plus web frontend) that you deploy to host your own federated instance; people then sign up on that instance and use it through a web client, interacting with the broader fediverse.
How do I get my own Misskey instance running?You can deploy Misskey with Docker, or build it from source: run pnpm compile-config, then pnpm build to compile the backend, frontend and assets, and pnpm start to launch the backend (node ./built/entry.js).
What do I need installed before building it?You need Node.js and pnpm, since the project is a pnpm-managed monorepo (backend, frontend, misskey-js packages) that uses esbuild and other pnpm scripts for its build pipeline.
What's the catch with running my own instance?Self-hosting means you're responsible for the server, moderation and upkeep yourself, and because Misskey is AGPL-3.0 licensed, anyone who runs a modified version publicly as a service is required to share their source changes too.
Do I have to host my own server to use Misskey?No — you can sign up on an existing public Misskey instance run by someone else, or stand up your own self-hosted instance if you want full control.
Can my instance talk to Mastodon and other fediverse apps?Yes, Misskey implements ActivityPub, the same federation protocol used by Mastodon and Pleroma, so accounts can follow and interact across instances and platforms.
Is Misskey available in other languages?Yes, the project uses Crowdin for localization, which lets contributors translate the interface into many languages.
How does the project keep UI and backend quality in check?Misskey uses Codecov to track test coverage, Chromatic for visual UI regression testing, and Sentry for catching production errors.
What are similar projects?mastodon, lemmy, owncast, PeerTube, social-app, ruflo, diaspora, forem
Size
384.9 MB
Stars
11.3K
Age
9y
Commits · 90 Days