summaryrefslogtreecommitdiff
path: root/Documentation/source/ja/getting-started.rst
diff options
context:
space:
mode:
authorBertrand Yuan <me@bertyuan.com>2026-04-27 20:52:54 +0800
committerBertrand Yuan <me@bertyuan.com>2026-04-27 20:53:14 +0800
commitdbb5e791f0c228369605d126dd590962ebe1eddc (patch)
tree8c83fc84bd9547630e6733929dec77e102e055a8 /Documentation/source/ja/getting-started.rst
parent658798b3a2378bb6df16cfbb16d707c6fb719e1e (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/getting-started.rst')
-rw-r--r--Documentation/source/ja/getting-started.rst72
1 files changed, 72 insertions, 0 deletions
diff --git a/Documentation/source/ja/getting-started.rst b/Documentation/source/ja/getting-started.rst
new file mode 100644
index 0000000..4d11693
--- /dev/null
+++ b/Documentation/source/ja/getting-started.rst
@@ -0,0 +1,72 @@
+はじめに
+========
+
+このページでは、ローカル開発の基本手順を説明します。依存関係、環境変数、データベース、アプリケーション起動、ドキュメントビルドを扱います。
+
+必要なツール
+------------
+
+次のツールを用意してください。
+
+* Next.js 15 に対応した Node.js;
+* pnpm 10.x;
+* ローカル PostgreSQL 用の Docker または Podman;
+* Git;
+* 任意: Sphinx。
+
+環境変数
+--------
+
+サンプルをコピーします。
+
+.. code-block:: bash
+
+ cp .env.example .env
+
+環境変数は ``src/env.js`` で ``@t3-oss/env-nextjs`` と ``zod`` により検証されます。ローカル UI やドキュメント確認だけであれば ``SKIP_ENV_VALIDATION=1`` を一時的に使えますが、本番では使わないでください。
+
+データベース
+------------
+
+ローカル PostgreSQL を起動します。
+
+.. code-block:: bash
+
+ ./start-database.sh
+
+必要に応じて次を実行します。
+
+.. code-block:: bash
+
+ pnpm payload:migrate
+ pnpm db:push
+
+アプリケーション起動
+--------------------
+
+.. code-block:: bash
+
+ pnpm install
+ pnpm dev
+
+公開サイトは通常 ``http://localhost:3000``、Payload 管理画面は ``/admin`` です。
+
+よく使うチェック
+----------------
+
+.. list-table::
+ :header-rows: 1
+ :widths: 24 50
+
+ * - コマンド
+ - 目的
+ * - ``pnpm lint``
+ - コンテンツリンク検証と Biome lint。
+ * - ``pnpm check``
+ - Biome チェック。
+ * - ``pnpm test``
+ - Vitest テスト。
+ * - ``pnpm build``
+ - Next.js アプリケーションのビルドとサイトマップ生成。
+ * - ``make -C Documentation html``
+ - Sphinx ドキュメントのビルド。