diff options
| author | Bertrand Yuan <me@bertyuan.com> | 2026-04-27 20:52:54 +0800 |
|---|---|---|
| committer | Bertrand Yuan <me@bertyuan.com> | 2026-04-27 20:53:14 +0800 |
| commit | dbb5e791f0c228369605d126dd590962ebe1eddc (patch) | |
| tree | 8c83fc84bd9547630e6733929dec77e102e055a8 /Documentation/source/ja/operations.rst | |
| parent | 658798b3a2378bb6df16cfbb16d707c6fb719e1e (diff) | |
docs: add comprehensive documentation for operations
This commit introduces a complete set of documentation files
covering various aspects of the project, including environment
setup, quality checks, command references, and architecture.
The documentation is structured to assist developers and
contributors in understanding the project's configuration,
workflow, and best practices.
Additionally, translations for Simplified and Traditional
Chinese have been added to ensure accessibility for a wider
audience. This enhances the overall usability and
maintainability of the project.
Signed-off-by: Bertrand Yuan <github@bertyuan.com>
Diffstat (limited to 'Documentation/source/ja/operations.rst')
| -rw-r--r-- | Documentation/source/ja/operations.rst | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/Documentation/source/ja/operations.rst b/Documentation/source/ja/operations.rst new file mode 100644 index 0000000..5436fd4 --- /dev/null +++ b/Documentation/source/ja/operations.rst @@ -0,0 +1,65 @@ +運用 +==== + +環境設定 +-------- + +主要な環境変数は ``src/env.js`` で検証されます。 + +.. list-table:: + :header-rows: 1 + :widths: 34 44 + + * - 変数 + - 用途 + * - ``DATABASE_URL`` + - PostgreSQL 接続文字列。 + * - ``RESEND_API_KEY`` + - Resend API key。 + * - ``RESEND_AUDIENCE_ID`` + - Resend audience ID。 + * - ``EMAIL_FROM`` + - 送信元メールアドレス。 + * - ``BETTER_AUTH_SECRET`` + - better-auth secret。本番では必須。 + * - ``GOOGLE_CLIENT_ID`` / ``GOOGLE_CLIENT_SECRET`` + - Google OAuth 認証情報。 + * - ``GITHUB_CLIENT_ID`` / ``GITHUB_CLIENT_SECRET`` + - GitHub OAuth 認証情報。 + +データベース手順 +---------------- + +Payload collection の変更: + +.. code-block:: bash + + pnpm payload:migrate:create + pnpm payload:migrate + pnpm payload:generate + +アプリケーション schema の変更: + +.. code-block:: bash + + pnpm db:generate + pnpm db:migrate + +品質チェック +------------ + +.. code-block:: bash + + pnpm lint + pnpm check + pnpm test + pnpm build + +ドキュメントビルド +------------------ + +.. code-block:: bash + + make -C Documentation html + +生成される ``Documentation/build`` はコミットしません。 |
