Webアプリケーション サンプルプロジェクト

CI code style: prettier license: MIT PRs: welcome

Webアプリケーションを作る際に必要なものを一通り揃えた最小限のサンプルプロジェクトです。

開発

要件

環境構築

  1. 依存パッケージをインストールします。プロジェクトのルートディレクトリで次のコマンドを実行してください。

    npm ci
  2. 環境変数ファイルを作成します。backend/.env.exampleをコピーしてbackend/.envを作成し、frontend/.env.exampleをコピーしてfrontend/.envを作成してください。

  3. データベースを起動します。ローカル環境でデータベースを起動する場合は、次のコマンドを実行してください。外部データベースを使用する場合は、次のコマンドを実行する代わりに環境変数ファイルに接続情報を設定してください。

    docker compose up
  4. データベースのスキーマを作成します。backendディレクトリで次のコマンドを実行してください。

    npx prisma db push
  5. データベースに初期データを投入します。backendディレクトリで次のコマンドを実行してください。

    npx prisma db seed

開発サーバーの起動

  1. データベースを起動します。外部データベースを使用する場合は、次のコマンドを実行する必要はありません。

    docker compose up
  2. バックエンドサーバーを起動します。backendディレクトリで次のコマンドを実行してください。

    npm run dev
  3. フロントエンドサーバーを起動します。frontendディレクトリで次のコマンドを実行してください。

    npm run dev

コミット前

コミット前には、次のコマンドを実行しコードスタイルと型のチェックを行ってください。

npm run lint && npm run type-check