استقرار برنامه NodeJS در لیارا

در ابتدا، پس از ساخت برنامه بایستی تمام فایل‌ها و پوشه‌هایی که قصد ندارید در لیارا آپلود شوند را، از پروژه پاک کنید. به عنوان مثال، باید پوشه node_modules را در پروژه خود پاک کنید؛ چرا که لیارا در حین فرایند استقرار، آن را برای شما ایجاد خواهد کرد. به صورت کلی، اگر که در پروژه خود فایلی به نام gitignore. دارید، کافیست تا فایل‌های و دایرکتوری‌های اشاره شده در این فایل را، از پروژه خود پاک کنید.

همچنین، پروژه شما باید شامل فایل package.json باشد؛ لیارا، در حین فرایند استقرار، به صورت خودکار این فایل را پیدا می‌کند و عملیات زیر را انجام می‌دهد:

در ادامه، بایستی پوشه پروژه خود را درون یک فایل zip قرار بدهید؛ سپس در برنامه خود، بر روی گزینه استقرار جدید کلیک کرده؛ وارد تب Drag & Drog شوید و فایل zip را آپلود کنید تا وارد مرحله بعدی استقرار شوید:

پس از آپلود پروژه، باید شخصی‌سازی‌های پروژه نظیر انتخاب نسخه، تعیین منطقه زمانی، اتصال دیسک، قابلیت build cache و ... را در برنامه خود، لحاظ کنید.

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

پس از ساخت برنامه، باید در مسیر اصلی پروژه، یک فایل به نام liaraignore. یا gitignore. ایجاد کنید و درون آن، اسامی تمامی فایل‌ها یا پوشه‌هایی که قصد ندارید در لیارا آپلود شوند را، وارد کنید؛ به عنوان مثال، نیازی به آپلود دایرکتوری node_modules به همراه محتوای آن نیست؛ چرا که لیارا در حین استقرار برنامه، آن را برای شما می‌سازد؛ پس بایستی نام این دایرکتوری در یکی از دو فایل فوق، نوشته شود؛ قطعه کد قرار گرفته در لینک زیر، یک gitignore. عالی برای برنامه‌های NodeJS است که می‌توانید از آن، استفاده کنید:

همچنین، پروژه شما باید شامل فایل package.json باشد؛ لیارا، در حین فرایند استقرار، به صورت خودکار این فایل را پیدا می‌کند و عملیات زیر را انجام می‌دهد:

قطعه کد زیر، یک نمونه از فایل package.json است که در آن اسکریپت start تعریف شده است:

{
"name": "node-getting-started",
"version": "1.0.0",
"description": "simple web server with expressjs",
"main": "server.js",
"scripts": {
  "start": "node server.js"
},
"license": "ISC",
"dependencies": {
  "express": "^4.17.1"
},
"devDependencies": {
  "eslint": "^8",
  "eslint-config-next": "14.0.4"
}
}

در ادامه، در مسیر اصلی پروژه، یک فایل به نام liara.json ایجاد کنید و قطعه کد زیر را در آن قرار دهید:

{
  "app": "my-web-app", 
  "port": 3005,
  "platform": "node",
}

در قطعه کد فوق، در فیلد app باید شناسه برنامه خود را به جای my-web-app وارد کنید و در فیلد port باید پورتی را وارد کنید که برنامه‌تان در آن، به درخواست کاربران گوش می‌دهد. فیلد platform هم پلتفرم برنامه شما را که NodeJS است، مشخص می‌کند.

لیارا در جهت استقرار سریع‌تر، برای نصب پکیج‌های npm، از mirror اختصاصی خود استفاده می‌کند؛ از همین رو، ممکن است که در نصب برخی از پکیج‌های جدید، دچار مشکل شود. برای رفع این مشکل، می‌توانید mirror لیارا را با قراردادن قطعه کد زیر در فایل liara.json، غیرفعال کنید:

{
  "node": {
  "mirror": false
}
}

برای تعیین نسخه NodeJS برنامه خود نیز، کافیست تا در فایل liara.json فیلد version را قرار دهید:

{
  "node": {
  "version": "22"
}
}

به صورت پیش‌فرض، منطقه‌ی زمانی برنامه‌تان بر روی Asia/Tehran تنظیم شده است؛ برای تغییر مقدار پیش‌فرض، می‌توانید از پارامتر timezone در فایل liara.json استفاده کنید؛ به عنوان مثال:

{
  "node": {
  "timezone": "America/Los_Angeles"
}
}

در نهایت، یک فایل liara.json می‌تواند مانند قطعه کد زیر باشد:

{
  "app": "my-web-app", 
  "port": 3005,
  "platform": "node",
  "node": {
  "mirror": true,
  "timezone": "America/Los_Angeles",
  "version": "22"
  }
}

در صورتی که قصد دارید برنامه‌تان را در تیم مدنظرتان، مستقر کنید، باید فیلد team-idرا به فایل liara.json مانند شکل زیر، اضافه کنید. مقدار این فیلد، باید شناسه تیم شما در لیارا باشد:

{
  "team-id": "your-team-id"
}

اکنون کافیست تا در مسیر اصلی پروژه و جایی که فایل liara.json قرار دارد؛ دستور زیر را اجرا کنید و منتظر بمانید تا عملیات استقرار تمام شود:

liara deploy

در حین فرایند استقرار، می‌توانید در ترمینال خود، لاگ‌های مربوط به آن را مشاهده بفرمایید.

پس از ساخت برنامه، باید در مسیر اصلی پروژه، یک فایل به نام gitignore. ایجاد کنید و درون آن، اسامی تمامی فایل‌ها یا پوشه‌هایی که قصد ندارید در لیارا آپلود شوند را، وارد کنید؛ به عنوان مثال، نیازی به آپلود دایرکتوری node_modules به همراه محتوای آن نیست؛ چرا که لیارا در حین استقرار برنامه، آن را برای شما می‌سازد؛ پس بایستی نام این دایرکتوری در فایل فوق، نوشته شود؛ قطعه کد قرار گرفته در لینک زیر، یک gitignore. عالی برای برنامه‌های NodeJS است که می‌توانید از آن، استفاده کنید:

همچنین، پروژه شما باید شامل فایل package.json باشد؛ لیارا، در حین فرایند استقرار، به صورت خودکار این فایل را پیدا می‌کند و عملیات زیر را انجام می‌دهد:

قطعه کد زیر، یک نمونه از فایل package.json است که در آن اسکریپت start تعریف شده است:

{
"name": "node-getting-started",
"version": "1.0.0",
"description": "simple web server with expressjs",
"main": "server.js",
"scripts": {
  "start": "node server.js"
},
"license": "ISC",
"dependencies": {
  "express": "^4.17.1"
},
"devDependencies": {
  "eslint": "^8",
  "eslint-config-next": "14.0.4"
}
}

لیارا در جهت استقرار سریع‌تر، برای نصب پکیج‌های npm، از mirror اختصاصی خود استفاده می‌کند؛ از همین رو، ممکن است که در نصب برخی از پکیج‌های جدید، دچار مشکل شود. برای رفع این مشکل، می‌توانید در مسیر اصلی پروژه، یک فایل به نام liara.json ایجاد کنید و mirror لیارا را با قراردادن قطعه کد زیر در این فایل، غیرفعال کنید:

{
  "node": {
  "mirror": false
}
}

همچنین، مانند قطعه کد زیر، بایستی در فیلدی به نام port در این فایل، مشخص کنید که برنامه‌تان در چه پورتی، به درخواست کاربران listen می‌کند:

{
  "port": 3005,
}

برای تعیین نسخه NodeJS برنامه خود نیز، کافیست تا در فایل liara.json فیلد version را قرار دهید:

{
  "node": {
  "version": "22"
}
}

به صورت پیش‌فرض، منطقه‌ی زمانی برنامه‌تان بر روی Asia/Tehran تنظیم شده است؛ برای تغییر مقدار پیش‌فرض، می‌توانید از پارامتر timezone در فایل liara.json استفاده کنید؛ به عنوان مثال:

{
  "node": {
  "timezone": "America/Los_Angeles"
}
}

در نهایت، یک فایل liara.json می‌تواند مانند قطعه کد زیر باشد:

{
  "port": 3005,
  "node": {
  "mirror": true,
  "timezone": "America/Los_Angeles",
  "version": "22"
  }
}

در صورتی که قصد دارید برنامه‌تان را در تیم مدنظرتان، مستقر کنید، باید فیلد team-idرا به فایل liara.json مانند شکل زیر، اضافه کنید. مقدار این فیلد، باید شناسه تیم شما در لیارا باشد:

{
  "team-id": "your-team-id"
}

در ادامه، بایستی یک ریپازیتوری در حساب گیت‌هاب خود برای برنامه‌مدنظرتان با نام دلخواه‌تان ایجاد کنید، برای این کار، پس از ورود به گیت‌هاب، وارد بخش Repositories شوید و بر روی دکمه New کلیک کنید؛ پس از نوشتن نام و توضیحات ریپازیتوری، سطح دسترسی ریپازیتوری را (public یا private)، انتخاب کنید و در نهایت بر روی دکمه create repository کلیک کنید تا ریپازیتوری برای‌تان ساخته شود:

اکنون، باید پروژه نهایی خود را در ریپازیتوری‌تان در گیت‌هاب آپلود کنید؛ حتماً در نظر داشته باشید که درون پروژه‌تان، فایل gitignore. قرار داشته باشد و درون آن، فایل‌های اضافی برنامه، که قصد ندارید آپلود شوند؛ لیست شده باشند. می‌توانید برای آپلود، مانند دستورات زیر در ترمینال ریشه پروژه‌تان، عمل کنید:

git init # تعریف اولیه مخزن در ریشه پروژه

git add . # اضافه کردن تمامی فایل‌ها به استیج

git commit -m "make ready to deploy on liara" # ثبت کامیت

git remote add origin https://github.com/your-account-user/your-repo-name.git # افزودن دسترسی ریموت به مخزن

git push origin master # آپلود پروژه در گیت‌هاب

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

بعد از اتصال به اکانت گیت‌هاب، بر روی گزینه ویرایش دسترسی‌ها کلیک کرده و ریپازیتوری (ریپازیتوری‌های) مدنظرتان را به حساب لیارا متصل کنید.

برای این کار در ابتدا، حساب شخصی یا سازمانی خود را انتخاب کنید؛ سپس در صورتی که قصد دارید تمام ریپازیتوری‌های حساب گیت‌هاب‌تان به لیارا متصل شود؛ گزینه All repositories را انتخاب کنید؛ اما اگر قصد دارید که فقط یک یا چند ریپازیتوری مدنظرتان را انتخاب کنید؛ گزینه Only select repositories را انتخاب کرده و در ادامه ریپازیتوری‌های مدنظرتان را در کشوی باز شده، انتخاب کنید. در نهایت، بر روی گزینه Install & Authorize کلیک کنید تا ریپازیتوری‌های انتخابی، به حساب لیارا، متصل شوند:

در نهایت، بر روی برنامه خود کلیک کرده وارد صفحه استقرار جدید شوید؛ سپس در منوی گیت‌هاب، ریپازیتوری مدنظرتان را انتخاب کرده و پس از انتخاب نوع استقرار (استقرار در صورت CI موفق یا استقرار خودکار) و branch مدنظرتان، بر روی گزینه اتصال به برنامه کلیک کنید تا برنامه‌تان به ریپازیتوری مدنظرتان متصل شود. در نهایت، کافیست تا یک‌بار بر روی گزینه استقرار دستی کلیک کنید تا آخرین commit شما در لیارا مستقر شود:

پس از انجام کارهای فوق، با هر بار push کردن پروژه‌تان در ریپازیتوری انتخاب شده، یک استقرار جدید مطابق آخرین تغییرات شما در لیارا، انجام خواهد شد.