Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 開発環境のセットアップ手順を詳細にする #14235

Merged
merged 11 commits into from
Jul 17, 2024
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,22 @@ If your language is not listed in Crowdin, please open an issue.
![Crowdin](https://d322cqt584bo4o.cloudfront.net/misskey/localized.svg)

## Development
### Setup
Before developing, you set up environment. Misskey requires Redis, PostgreSQL, and FFmpeg. There are a few ways to proceed.
KisaragiEffective marked this conversation as resolved.
Show resolved Hide resolved

#### Use system-wide software
You could install them in system-wide (such as from package manager).

#### Use `docker compose`
You could obtain all-in-one container by typing `docker compose -f $PROJECT_ROOT/compose.local-db.yml`.
KisaragiEffective marked this conversation as resolved.
Show resolved Hide resolved

#### Use Devcontainer
Devcontainer also has necessary setting.

> [!NOTE]
> Support from JetBrain's IDE may be limited. In doubtful situation, we recommend using VSCode.

KisaragiEffective marked this conversation as resolved.
Show resolved Hide resolved
### Start developing
During development, it is useful to use the

```
Expand Down