diff options
| author | RyotaK <49341894+Ry0taK@users.noreply.github.com> | 2023-02-12 09:07:56 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-12 09:07:56 +0900 |
| commit | 3c7e1ff92ef4100347ee2151c3edfc431853532b (patch) | |
| tree | 0959cf408975778a459552c20bfb628750b0c0ea /CONTRIBUTING.md | |
| parent | fix: 広告のexpiresAtをLocalTZ分ずらして初期化 (#9876) (diff) | |
| download | sharkey-3c7e1ff92ef4100347ee2151c3edfc431853532b.tar.gz sharkey-3c7e1ff92ef4100347ee2151c3edfc431853532b.tar.bz2 sharkey-3c7e1ff92ef4100347ee2151c3edfc431853532b.zip | |
Dev Containerの設定を追加 (#9872)
* Dev Containerの設定を追加
* テンプレート生成時に含まれていたコメントを削除
* 起動スクリプトを分割
JSONの中にベタ書きすると長くなるので
* 改行
* Dev Containerの使用方法を追記
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e539926789..de0a1abb45 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -111,6 +111,25 @@ command. - Vite HMR (just the `vite` command) is available. The behavior may be different from production. - Service Worker is watched by esbuild. +### Dev Container +Instead of running `pnpm` locally, you can use Dev Container to set up your development environment. +To use Dev Container, open the project directory on VSCode with Dev Containers installed. + +It will run the following command automatically inside the container. +``` bash +git submodule update --init +pnpm install --frozen-lockfile +cp .devcontainer/devcontainer.yml .config/default.yml +pnpm build +pnpm migrate +``` + +After finishing the migration, run the `pnpm dev` command to start the development server. + +``` bash +pnpm dev +``` + ## Testing - Test codes are located in [`/packages/backend/test`](/packages/backend/test). |