misskey

(β˜… 11,299)

🌎 A completely free and open interplanetary-microblogging platform πŸš€

Showing a partial file list β€” download the zip above to see everything.

  • .coderabbit.yaml
  • .dockerignore
  • .dockleignore
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .gitmodules
  • .node-version
  • .vsls.json
  • AGENTS.md
  • CHANGELOG.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • codecov.yml
  • compose.local-db.yml
  • compose_example.yml
  • CONTRIBUTING.md
  • COPYING
  • crowdin.yml
  • Dockerfile
  • healthcheck.sh
  • LICENSE
  • package.json
  • Procfile
  • README.md
  • ROADMAP.md
  • SECURITY.md

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/misskey-dev/misskey

Downloads the entire project code from GitHub to your computer.

cd misskey

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f compose.local-db.yml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation