開発を始める

Z-CMS は、Node.js、pnpm、Next.js、NestJS、PostgreSQL、Redis で構成された TypeScript モノレポです。

必要な環境

cp .env.example .env
pnpm install
pnpm bootstrap
pnpm dev

変更を提出する前に、次のコマンドを実行してください。

pnpm typecheck
pnpm lint
pnpm test
pnpm verify

pnpm verify はテナント分離、サンドボックスからの脱出、パッケージ署名など、重要なセキュリティ要件を検証します。

プラグインやテーマを作るために、このリポジトリをチェックアウトする必要はありません。CLI をインストールして、プロジェクトのひな型を作成します。

npm install -g @zcmsorg/cli@latest
zcms init

init はプラグインとテーマのどちらを作るかを尋ね、ビルド、型チェック、テスト、パッケージ化、署名に必要な設定を含むプロジェクトを生成します。実際のサイトでしか検証されない 2 つのビルド要件も、最初から満たしています。

そのうえで、開発対象に合った手順を選択してください。