Skip to content

README.ja.md

Latest commit

 

History

History
212 lines (154 loc) · 6.82 KB

README.ja.md

File metadata and controls

212 lines (154 loc) · 6.82 KB

Nuct Logo

ビジネスに集中し、インフラは Nuct に任せましょう。

NestJS + Vue3 ベースのエンタープライズ級フルスタックスキャフォールド。マルチテナント、RBAC、Cursor Rules & Skills による AI 支援開発に対応。

English · 简体中文 · 繁體中文 · 日本語 · Русский

Commit activity License Repo size Top language

  • 小〜中規模アプリの迅速開発スキャフォールド
  • Cursor Rules & Skills を事前設定し、AI 支援開発に対応

スクリーンショット 📸

目次 📚

概要 ✨

  • デフォルトアカウント：admin / a123456 🔑
  • マルチテナント分離、RBAC、SSO 対応 — 管理画面や SaaS プラットフォームに最適

プロジェクト構成 🧱

nuct/
├── backend/          # 管理バックエンド (NestJS, ポート 7001)
├── backend-user/     # C 端ユーザー API (NestJS, ポート 8001)
├── frontend/         # 管理フロントエンド (Vue3, ポート 8088)
└── README.md

技術スタック 🛠

レイヤー 技術
バックエンド NestJS、TypeScript、TypeORM、Redis、MySQL、JWT、Swagger、Bull
フロントエンド Vue3、Vite5、Ant Design Vue4、TypeScript5、Pinia、UnoCSS

クイックリンク 🔗

環境要件 📦

  • Node.js 20+
  • Docker 20.x+（docker compose 2.17.0+）
  • MySQL 8.x+
  • pnpm パッケージマネージャー

クイックスタート 🚀

Docker

cd backend
pnpm docker:up
# または
docker compose --env-file .env --env-file .env.production up -d --no-build

起動後：Swagger http://localhost:7001/api-docs/

コンテナ停止：

cd backend
pnpm docker:down

ローカル開発

1. クローン

git clone https://github.com/zeeklog/nuct
cd nuct

2. セットアップ

  • データベース：backend/deploy/sql/nest_admin.sql を実行

  • 設定：.env.example → .env、.env.development.example → .env.development をコピー

  • RSA 鍵（パスワード暗号化用）：

    cd backend
mkdir -p RSA_PRIVATE_KEY
openssl genrsa -out RSA_PRIVATE_KEY/rsa-private.pem 2048

    .env に RSA_PRIVATE_KEY_PATH=RSA_PRIVATE_KEY/rsa-private.pem を設定。

オプション — Docker で MySQL/Redis を起動：

cd backend
docker compose --env-file .env --env-file .env.development run -d --service-ports mysql
docker compose --env-file .env --env-file .env.development run -d --service-ports redis

3. インストールと起動

pnpm install
pnpm migration:run   # backend で実行
pnpm dev

4. アクセス

サブプロジェクト 📁

ディレクトリ 説明 ポート
backend/ 管理バックエンド (NestJS) 7001
backend-user/ C 端ユーザー API (NestJS) 8001
frontend/ 管理フロントエンド (Vue3) 8088

データベースマイグレーション 🗄

プロジェクトルートで実行：

pnpm migration:run      # マイグレーション適用
pnpm migration:generate # マイグレーション生成
pnpm migration:revert   # ロールバック

エンティティや DB 設定を変更した場合は、先に backend で pnpm build を実行してからマイグレーションを実行してください。

Cursor AI ルール 🤖

.cursor/ にルールとスキルを事前設定し、AI 支援開発に対応しています。

ルール

ファイル 説明 スコープ
rules/00-project.mdc プロジェクト構成と全体規範 常時
rules/01-frontend-style.mdc フロントエンド CSS と命名規範 フロントエンド
rules/01-data-design.mdc DB 設計と RBAC モデル バックエンド
rules/02-backend.mdc NestJS バックエンド規範 backend/**/*.ts
rules/03-frontend.mdc Vue3 フロントエンド規範 frontend/**/*.{ts,vue}
rules/04-backend-docs.mdc バックエンド API リファレンス バックエンド
rules/tenant-init.mdc テナント初期化ロジック tenant/**/*.ts

スキル

スキル パス 用途
nest-admin-backend skills/nest-admin-backend/SKILL.md バックエンド API、コントローラー、サービス、マイグレーション
nest-admin-crud skills/nest-admin-crud/SKILL.md CRUD モジュール一式（エンティティ、DTO、Service、Controller、メニュー、フロントエンド）
nest-admin-permission skills/nest-admin-permission/SKILL.md RBAC、メニュー、definePermission、sys_menu 設定

貢献 🤝

Star と PR を歓迎します。

謝辞 🙏

以下のオープンソースプロジェクトをベースにしています：

ライセンス

BSL 1.1