Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 3.87 KB

README.md

File metadata and controls

80 lines (52 loc) · 3.87 KB

SimpleGrants Frontend 📱

目次 📒

要件 📝

  • NodeJS (v17.5+)
  • yarn
  • Prisma CLI

インストールとセットアップ 🧪

フロントエンドは認証のために NextAuth を利用しています。プラットフォームの要件に基づいて 認証プロバイダー を更新してください。

# セットアップのために
$ yarn install

# .envをコピーする
$ cp .env.example .env.local

# 本番用に実行する場合、.env.productionを使用
$ cp .env.example .env.production

⚠️ .env.local ファイルを自分の値で更新してください!

アプリの実行 🚀

💡 フロントエンドを実行する前に、バックエンドが既に動作していることを確認してください!

ローカル開発 👨🏻‍💻

これらのコマンドを実行する必要はありません。詳細は このセクション を参照してください。 開発用にローカルで実行する場合、注意すべきいくつかの点があります:

  1. Prismaスキーマがバックエンドと常に同期していることを確認してください。これを行うには、npm run generate を実行してください。
  2. 以下のコマンドを実行して開始します。
# 開発モード
$ yarn dev -p 3001

本番環境へのデプロイ 🔥

これらのコマンドを実行する必要はありません。詳細は このセクション を参照してください。 このアプリケーションを本番環境にデプロイする場合、セットアップは少し簡単ですが、注意すべきいくつかの点があります:

  1. .env.productionがセットアップされていることを確認してください。これは docker-compose.yml ファイルによって使用されます。
  2. next.config.jsは画像ファイルがホストされているドメインとホスト名を含むべきです。
# 本番モード
$ yarn build && yarn start

追加のノート 🧠

Prisma Schema

フロントエンドは NextAuth を利用して

おり、バックエンドとスキーマ依存関係を共有しています。Prismaスキーマがローカルで常に同期していることを確実にするために、バックエンドで npm run generate を実行してください。これにより、ここにスキーマがコピーされ、Prisma generateが実行されます。これはローカル開発のためだけに必要です。本番環境のセットアップが最新のスキーマを使用するように、これをコミットしてください。

デプロイ 🚀

このアプリをデプロイする最も簡単な方法は、Next.js の創設者が提供する Vercel Platform を使用することです。

詳細については、Next.js のデプロイメントドキュメントを確認してください。ただし、バックエンドとの連携を確実にするためには、もっと多くのセットアップが必要です。