2.7 KiB
مستندات توسعهدهندگان (Developer Documentation)
به مستندات رسمی سامانه «کنینا ایران» خوش آمدید. این مستندات به منظور راهنمایی توسعهدهندگان، مهندسین دواپس و تیم فنی شرکت نوشته شده است و نباید در دسترس کاربران عمومی قرار گیرد.
در این دایرکتوری تمامی ساختارها، معماریها، قوانین کدنویسی و مراحل انتشار (Deployment) به دقت تدوین شدهاند تا سرعت 온بوردینگ (Onboarding) توسعهدهندگان جدید افزایش یافته و نگهداری کدهای قدیمی با کمترین ریسک انجام شود.
فهرست مطالب (Table of Contents)
لطفاً بر اساس نیاز خود به هر یک از بخشهای زیر مراجعه کنید:
-
معرفی پروژه و معماری (Introduction)
- پروژه چیست، قابلیتهای آن کدامند و چرا از این ابزارها (Next.js & NestJS) استفاده شده است.
-
راهنمای کاربری و نقشها (User Guide)
- انواع کاربران سیستم (کاربران عادی، تجاری و مدیران) و اینکه هر کدام قادر به انجام چه کارهایی هستند.
-
راهنمای توسعهدهندگان (Developer Guide)
- (مهمترین بخش برای دولوپرها) ساختار پوشهها، استانداردهای کدنویسی، مدیریت State و قوانین توسعه بکاند و فرانتاند.
-
راهاندازی و انتشار سیستم (Setup & Deployment)
- نحوه اجرای محیط دولوپ روی سیستم شخصی، روند خروجی گرفتن (Build) و دستورات سرور پروداکشن با استفاده از PM2 و Nginx.
-
دواپس و مانیتورینگ سیستم (DevOps & Monitoring)
- مدیریت و بررسی سلامت سرور، لاگگیری و خودکارسازی دیپلوی (CI/CD).
-
راهنمای تست سیستم (Software Testing)
- انواع تستهایی که روی فرانتاند و بکاند انجام میگیرد و نحوه اجرای آنها برای تضمین کیفیت کدها.
توجه: در صورت اضافه شدن ماژولها و ابزارهای جدید به پروژه، لطفاً مستندات مربوطه را در همین پوشه بروزرسانی نمایید.