開発ガイド
BaiZe Frameworkで開発を始めるための完全ガイド
1. プロジェクト構築ガイド
1. 環境準備
BaiZe Frameworkの開発を開始する前に、以下の環境を準備する必要があります:
Node.js
バージョン >= 18(node -vコマンドで確認、nvmの使用を推奨)
Java
Java 8+Spring Boot 2.X)
MySQL
バージョン 5.7+(5.7を含む)
Redis
キャッシュおよびセッション管理用
2. コードの取得
GitHubからプロジェクトのコードをクローンします:
# バックエンドプロジェクト
git clone https://github.com/your-org/baize-backend.git
# フロントエンドプロジェクト
git clone https://github.com/your-org/baize-frontend.git
プロジェクト構成
バックエンド:
- Java 8 + Spring Boot 2.X の場合
フロントエンド:
- JavaScript版
3. データベース設定
3.1 SQLスクリプトの実行
データベースSQLスクリプトを実行します:
# SQLファイルの場所:/sql/baize.sql
mysql -u root -p < baize-backend/sql/baize.sql
実行が成功すると、baizeデータベースが作成されます。
3.2 Redisの起動
Redis環境がある場合はそのまま使用できます。ない場合は以下からインストールしてください:
- Linux版: https://redis.io/download
- Windows版: https://github.com/microsoftarchive/redis/releases
4. バックエンド設定
4.1 プロジェクトのインポート
baize-backend プロジェクトをIDE(IntelliJ IDEAまたはEclipse)にインポートします。
4.2 設定ファイルの修正
IDEのエンコーディングを確認してください。YAML設定ファイルに日本語のコメントが含まれているため、UTF-8で設定する必要があります。
baiZe-baseの設定ファイルを修正
baiZe-base/src/main/resources/dev/baiZe-base.yaml ファイルを開きます:
(1)JDBCパラメータの修正
spring:
datasource:
url: jdbc:p6spy:mysql://127.0.0.1:3306/baize?autoReconnect=true&useServerPreparedStmts=false&rewriteBatchedStatements=true&characterEncoding=UTF-8&useSSL=false&allowMultiQueries=true&serverTimezone=Asia/Shanghai
username: root
password: your_password
(2)Redisパラメータの修正
redis:
database: 1
host: 127.0.0.1
port: 6379
password:
timeout: 10000ms
lettuce:
pool:
max-active: 8
min-idle: 2
max-idle: 8
max-wait: -1ms
(3)ファイルアップロード設定
ファイルアップロードはデフォルトでローカル保存設定になっています(file.storage.mode = local)。初期段階では変更不要で起動できます。クラウドストレージ使用時は別途設定が必要です。
baiZe-adminの設定ファイルを修正
baiZe-admin/src/main/resources/dev/application.yaml ファイルを開きます:
ログディレクトリの設定
project:
name: baize-admin
log-directory: /home/baize/${project.name}/${spring.profiles.active}
ポートの設定
server:
port: 1024
servlet:
context-path: /
5. バックエンド起動
baiZe-admin プロジェクトの AdminApplication 起動クラスを実行します。
✓ 起動成功の確認
Swagger UIにアクセスして確認します:
- URL:
http://localhost:1024/doc.html - アカウント:
admin - パスワード:
123456
6. フロントエンド起動
6.1 JavaScript版またはTypeScript版の選択
推奨:JavaScript版はシンプルで使いやすいため、特別な理由がない限りJS版を推奨します。
- JS版を選択:
baize-frontendディレクトリへ - TS版を選択: TypeScript版のディレクトリへ
6.2 依存関係のインストール
cd baize-frontend
npm install
6.3 開発サーバーの起動
npm run dev
6.4 フロントエンドへのアクセス
✓ アクセス情報
- URL:
http://localhost:8081 - アカウント:
admin - パスワード:
123456
7. 重要な3つの単語
BaiZe Frameworkプロジェクトには以下の3つの重要な単語が登場します:
support(サポート)
ベースモジュール(baiZe-base)
ビジネスに関わらない基本的な機能を提供:
- システムパラメータ設定
- データ辞書
- ファイル管理
- キャッシュ管理
- 心拍機能
- ログインログ
- データ変更履歴
- 共通ツールクラス
system(システム)
管理モジュール(baiZe-admin)
システム管理機能(ビジネスに関わるが比較的普遍的なもの):
- 従業員管理
- 部門管理
- ロール管理
- 権限管理
- メニュー管理
business(ビジネス)
業務モジュール(baiZe-admin)
具体的なビジネス機能:
- 例:進銷存ERPシステムの場合
- 商品管理
- 倉庫管理
- 入出庫管理
- など、具体的な要件に応じて実装
| 区分 | 説明 | 所属モジュール | ビジネス関連 | 例 |
|---|---|---|---|---|
| support | サポート | baiZe-base | なし | ファイル、辞書、CAPTCHA、カスタム列など |
| system | システム | baiZe-admin | 少なめ | 従業員、メニュー、ロール、権限など |
| business | ビジネス | baiZe-admin | すべて | 具体的な要件に応じて実装 |