پرش به مطلب اصلی

ایجاد اپلیکیشن جدید با CLI

ابزار CLI فریمورک کیمیا امکان ایجاد سریع و آسان اپلیکیشن‌های جدید را فراهم می‌کند. این ابزار ساختار پایه اپلیکیشن را به صورت خودکار ایجاد کرده و تمام فایل‌های ضروری را تولید می‌کند.

نصب CLI​

ابتدا ابزار CLI را نصب کنید:

npm install -g @kimia-framework/cli
اطلاع

همچنین میتوانید از طریق npx @kimia-framework/cli create-app my_app برنامه خود را سریعتر بسازید.

استفاده از دستور create-app​

سینتکس پایه​

kimia create-app <app-name> [lang]

پارامترها​

  • <app-name>: نام اپلیکیشن (الزامی) - باید یک شناسه منحصر به فرد باشد
  • [lang]: زبان محلی پیش‌فرض (اختیاری) - پیش‌فرض: fa
    • fa: فارسی
    • en: انگلیسی

مثال‌ها​

# ایجاد اپلیکیشن با نام my-app و زبان پیش‌فرض فارسی
kimia create-app my-app

# ایجاد اپلیکیشن با نام account و زبان انگلیسی
kimia create-app account en

# ایجاد اپلیکیشن با نام blog
kimia create-app blog

نام مستعار​

می‌توانید از نام مستعار a نیز استفاده کنید:

kimia a my-app

ساختار اپلیکیشنی که ایجاد می‌شود​

پس از اجرای دستور، ساختار زیر به صورت خودکار ایجاد می‌شود:

my-app/
├── app/
│   ├── apis/
│   │   ├── apis.ts
│   │   └── base.ts
│   ├── events/
│   │   └── init.ts
│   ├── interfaces.ts
│   ├── middlewares/
│   │   └── middlewares.ts
│   ├── models/
│   │   ├── interfaces.ts
│   │   └── models.ts
│   ├── views/
│   │   ├── base.ts
│   │   └── views.ts
│   ├── error-handler.ts
│   └── app.ts
├── resources/
│   ├── assets/
│   │   ├── favicon.png
│   │   └── logo.png
│   ├── locales/
│   │   └── fa/  # یا en
│   │       ├── info.ts
│   │       ├── main.ts
│   │       └── msgs.ts
│   └── templates/
│       ├── index.twing.html
│       └── layout/
│           └── base.twing.html
├── routes/
│   ├── api.ts
│   └── web.ts
├── .gitignore
├── local.ts
├── package.json
├── README.md
├── settings.json
└── tsconfig.json

فایل‌های کلیدی​

app.ts​

فایل متادیتای اپلیکیشن که شامل اطلاعات پایه مانند نام، نسخه، زبان‌های پشتیبانی شده و تنظیمات Swagger است.

package.json​

فایل پیکربندی npm با تمام وابستگی‌های لازم برای اجرای اپلیکیشن.

settings.json​

فایل تنظیمات اصلی سرور شامل پورت، ذخیره‌سازی و اپلیکیشن‌های باز.

local.ts​

فایل راه‌انداز محلی برای توسعه و تست اپلیکیشن.

مراحل بعدی پس از ایجاد​

  1. ورود به دایرکتوری اپلیکیشن:

    cd my-app

  2. نصب وابستگی‌ها:

    npm install

  3. اجرای اپلیکیشن در حالت توسعه:

    npm run dev

  4. باز کردن مرورگر: اپلیکیشن معمولاً روی http://localhost:8081 اجرا می‌شود.

سفارشی‌سازی​

پس از ایجاد اپلیکیشن، می‌توانید:

  • متادیتای اپلیکیشن را در app.ts تغییر دهید
  • مدل‌های داده خود را در app/models/ اضافه کنید
  • APIهای خود را در app/apis/ پیاده‌سازی کنید
  • نماهای وب را در app/views/ تعریف کنید
  • مسیرها را در routes/ پیکربندی کنید
  • فایل‌های زبان محلی را در resources/locales/ ویرایش کنید

نکات مهم​

  • نام اپلیکیشن باید منحصر به فرد باشد و از کاراکترهای مجاز استفاده کند
  • اگر دایرکتوری با نام اپلیکیشن از قبل وجود داشته باشد، خطا رخ می‌دهد
  • ابزار CLI به صورت خودکار وابستگی‌ها را نصب می‌کند
  • ساختار ایجاد شده بر اساس بهترین روش‌های فریمورک کیمیا است

عیب‌یابی​

خطای "Directory already exists"​

اگر دایرکتوری با نام انتخابی وجود داشته باشد، نام دیگری انتخاب کنید یا دایرکتوری موجود را حذف کنید.

خطای نصب وابستگی‌ها​

اگر نصب npm با خطا مواجه شد، مطمئن شوید Node.js و npm به درستی نصب شده‌اند و اتصال اینترنت دارید.

خطای اجرا​

اگر اپلیکیشن اجرا نشد، فایل‌های settings.json و local.ts را بررسی کنید و مطمئن شوید پورت 8081 آزاد است.