توسعه · مستندات رسمی

راهنمای توسعه

وب‌سایت رسمی یک برنامهٔ Next.js جدا از زیرساخت بلاک‌چین است. این راهنما سازمان آن و قواعدی را که باید در هر تغییر رعایت شود توضیح می‌دهد.

پشتهٔ فناوری و سازمان

وب‌سایت از Next.js با App Router، React، TypeScript و Bootstrap 5 به‌همراه یک برگهٔ سبک اختصاصی BI3LYX استفاده می‌کند. صفحات تحریریه از داده‌های نوع‌دار در مخزن تولید می‌شوند.

app/
مسیرها، چیدمان‌ها، فراداده، نقشهٔ سایت، فید RSS و مسیر وضعیت.
components/
کامپوننت‌های رابط قابل استفادهٔ مجدد، از جمله ناوبری، کارت‌ها و کاوشگر.
lib/
داده‌های تحریریهٔ نوع‌دار، پیکربندی وب‌سایت و مدل‌های API آینده.
tests/
آزمون‌های محتوا، ناوبری، کامپوننت‌ها و رندر صفحات.

دستورات محلی

  • npm install — نصب وابستگی‌ها.
  • npm run dev — راه‌اندازی سرور توسعه.
  • npm run typecheck — بررسی TypeScript بدون تولید فایل.
  • npm run lint — تحلیل کد با ESLint.
  • npm test — اجرای مجموعهٔ آزمون‌ها.
  • npm run build — ساخت بیلد تولید.
  • npm start — راه‌اندازی بیلد Next.js.

انتشار محتوا

صفحات مستندات و اخبار با بلوک‌های نوع‌دار توصیف می‌شوند. هر انتشار جدید باید یک اسلاگ یکتا، عنوان، توضیح، تاریخ و متنی بدون دادهٔ تأییدنشده ارائه دهد.

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

قواعد یکپارچه‌سازی API

  • لایهٔ دسترسی سرور را جدا از کامپوننت‌های نمایش نگه دارید.
  • نشانی API را فقط از طریق متغیر محیطی پیکربندی کنید.
  • مهلت زمانی و وضعیت خطای صریح را در نظر بگیرید.
  • طرح‌های پاسخ را پیش از نمایش اعتبارسنجی کنید.
  • هرگز نشانی RPC، یک راز یا دادهٔ کیف پول را افشا نکنید.

مشارکت و اعتبارسنجی

  • هیچ تغییری مستقیماً از مخزن وب‌سایت در زیرساخت تولید انجام نمی‌شود.
  • هر تغییری باید نوع‌بندی، لینت، آزمون‌ها و بیلد را بگذراند.
  • کامیت‌ها و استقرارها نیازمند مجوز مسئول پروژه هستند.
  • فایل‌های اجرایی هرگز بدون تأیید و امضا از وب‌سایت منتشر نمی‌شوند.