31 lines
2.7 KiB
Markdown
31 lines
2.7 KiB
Markdown
# مستندات توسعهدهندگان (Developer Documentation)
|
|
|
|
به مستندات رسمی سامانه «کنینا ایران» خوش آمدید. این مستندات به منظور راهنمایی توسعهدهندگان، مهندسین دواپس و تیم فنی شرکت نوشته شده است و نباید در دسترس کاربران عمومی قرار گیرد.
|
|
|
|
در این دایرکتوری تمامی ساختارها، معماریها، قوانین کدنویسی و مراحل انتشار (Deployment) به دقت تدوین شدهاند تا سرعت 온بوردینگ (Onboarding) توسعهدهندگان جدید افزایش یافته و نگهداری کدهای قدیمی با کمترین ریسک انجام شود.
|
|
|
|
## فهرست مطالب (Table of Contents)
|
|
|
|
لطفاً بر اساس نیاز خود به هر یک از بخشهای زیر مراجعه کنید:
|
|
|
|
1. [معرفی پروژه و معماری (Introduction)](01-introduction.md)
|
|
- پروژه چیست، قابلیتهای آن کدامند و چرا از این ابزارها (Next.js & NestJS) استفاده شده است.
|
|
|
|
2. [راهنمای کاربری و نقشها (User Guide)](02-user-guide.md)
|
|
- انواع کاربران سیستم (کاربران عادی، تجاری و مدیران) و اینکه هر کدام قادر به انجام چه کارهایی هستند.
|
|
|
|
3. [راهنمای توسعهدهندگان (Developer Guide)](03-developer-guide.md)
|
|
- **(مهمترین بخش برای دولوپرها)** ساختار پوشهها، استانداردهای کدنویسی، مدیریت State و قوانین توسعه بکاند و فرانتاند.
|
|
|
|
4. [راهاندازی و انتشار سیستم (Setup & Deployment)](04-setup-and-deployment.md)
|
|
- نحوه اجرای محیط دولوپ روی سیستم شخصی، روند خروجی گرفتن (Build) و دستورات سرور پروداکشن با استفاده از PM2 و Nginx.
|
|
|
|
5. [دواپس و مانیتورینگ سیستم (DevOps & Monitoring)](05-devops-and-monitoring.md)
|
|
- مدیریت و بررسی سلامت سرور، لاگگیری و خودکارسازی دیپلوی (CI/CD).
|
|
|
|
6. [راهنمای تست سیستم (Software Testing)](06-testing.md)
|
|
- انواع تستهایی که روی فرانتاند و بکاند انجام میگیرد و نحوه اجرای آنها برای تضمین کیفیت کدها.
|
|
|
|
---
|
|
**توجه:** در صورت اضافه شدن ماژولها و ابزارهای جدید به پروژه، لطفاً مستندات مربوطه را در همین پوشه بروزرسانی نمایید.
|