Giao diện

create-digiforce-nc-app ​

Packagecreate-digiforce-nc-app (unscoped)
Vai tròScaffolding tool - tạo project Digiforce mới từ template

Tổng quan ​

create-digiforce-nc-app là CLI scaffolding tool giúp khởi tạo một ứng dụng Digiforce hoàn chỉnh với cấu trúc thư mục, cấu hình database, và các file cần thiết.

Cách sử dụng ​

bash
# Với bun
bun create digiforce-nc-app my-app

# Với npx
npx create-digiforce-nc-app my-app

# Với tùy chọn
bun create digiforce-nc-app my-app -d postgres

Tùy chọn CLI ​

OptionMô tảMặc định
-d, --databaseDatabase dialect (postgres, mysql, sqlite)sqlite
-e, --envLoại environment (production, development)development
--skip-installBỏ qua bước bun installfalse

AppGenerator ​

AppGenerator là class chính thực hiện quá trình scaffolding:

Các bước tạo project ​

  1. Tạo thư mục gốc - mkdir my-app
  2. Generate package.json - khai báo dependencies, scripts (start, dev, install-plugin)
  3. Generate .env - cấu hình environment variables (DB connection, port, secret key)
  4. Cấu hình database - tạo file config phù hợp với dialect đã chọn
  5. Copy template files - tsconfig.json, .gitignore, và các file boilerplate
  6. Install dependencies - chạy bun install (trừ khi --skip-install)

Cấu trúc project được tạo ​

my-app/
├── .env                    # Environment variables
├── .gitignore
├── package.json            # Dependencies & scripts
├── tsconfig.json
├── storage/                # SQLite DB, uploads, logs
│   └── db/
│       └── digiforce.sqlite
└── docker/
    └── docker-compose.yml  # (nếu dùng postgres/mysql)

File .env mẫu ​

bash
APP_PORT=13000
APP_ENV=development
APP_KEY=random-secret-key

DB_DIALECT=postgres
DB_HOST=localhost
DB_PORT=5432
DB_DATABASE=digiforce
DB_USER=digiforce
DB_PASSWORD=digiforce

Ví dụ sử dụng ​

bash
# Tạo app với PostgreSQL
npx create-digiforce-nc-app my-project -d postgres

# Di chuyển vào thư mục project
cd my-project

# Khởi động ứng dụng
bun dev

Sau khi chạy bun dev, ứng dụng sẽ:

  1. Kết nối database
  2. Chạy migration / install plugin mặc định
  3. Mở server tại http://localhost:13000

TIP

Đối với production, sử dụng PostgreSQL hoặc MySQL. SQLite chỉ phù hợp cho development và thử nghiệm.