💾

misskeyの開発環境を立ち上げるメモ

2024/12/08に公開

このメモではdevcontainerは使いません。

必要なもの

  • docker(desktopでも可)
  • node(結構新しいのじゃないと動かない)
  • pnpm(npm i -g pnpmで入れてあげてください)
  • git

立ち上げ方

まずはmisskeyをクローンしよう

git clone https://github.com/misskey-dev/misskey

出来たらmisskeyに移動してあげて、必要なものを入れる

cd misskey
git submodule update --init
pnpm install --frozen-lockfile

必要なのはpostgresqlとredisなのでdockerで立ち上げる

cp .devcontainer/devcontainer.yml .config/default.yml
cp compose.local-db.yml compose.yml
cp .config/docker_example.env .config/docker.env

default.ymlとdocker.envのPOSTGRESQL_{USER/PASSWORD}が違うので、どっちかに合わせる。
この時点でコンテナは立ち上げていい

docker compose up -d

そして、misskey本体がmisskey-jsとゲーム関連を要求してくるので一度ビルドしてあげる

pnpm build
pnpm migrate

ここまで出来たらあとはこれで開発環境が立ち上がる。

pnpm dev
DONE *  [core boot]     All workers started
DONE *  [core boot]     Now listening on port 3000 on http://127.0.0.1:3000

って出てきたら下のリンクにアクセスしてみよう
http://127.0.0.1:5173/

開発環境だ、かっこいいね
DEV BUILD

参考

https://github.com/misskey-dev/misskey/blob/develop/CONTRIBUTING.md#development

Discussion