Skip to content

Commit

Permalink
docs: improve README_developer.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kizahasi committed Sep 8, 2024
1 parent f6b0a74 commit f564adc
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README_developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Flocon

(Netlify や fly.io にデプロイする場合は必要ありません)

- yarn のインストール
- yarn のインストール(corepack を有効化している場合は、corepack によって自動的にインストールされます)
- Node.js v14, v16, v18 のいずれかのインストール

## husky のインストール
Expand All @@ -52,6 +52,8 @@ Flocon リポジトリへの Pull Request の作成を考えていない場合

データベースとして PostgreSQL もしくは MySQL を使う場合は対応するデータベースサーバーを起動しておく必要があります。SQLite の場合は不要です。

API サーバーを動かすには、次のコマンドを実行してください。

```console
cd ./apps/api-server
yarn run start
Expand All @@ -61,6 +63,8 @@ yarn run start

[環境変数のセット](https://flocon.app/docs/server/details/web-server/vars)が必須です。また、環境変数のセットにおいて、Firebase プロジェクトの準備も必要になります。

Web サーバーを動かすには、次のコマンドを実行してください。

開発用サーバーを動かす場合:

```console
Expand Down Expand Up @@ -107,7 +111,7 @@ yarn run storybook

### クイックスタート

Node.js v16 以降をインストールし、次のコマンドを実行することで、全てのパッケージをテストできます。
Node.js v16 以降をインストールし、一例として、次のコマンドを実行することで、全てのパッケージをテストできます。

#### Linux

Expand Down

0 comments on commit f564adc

Please sign in to comment.