parsa/canina
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
main
canina/docs
History
parsaaghayi bd49fbc4a0
Some checks failed
Deploy Canina / deploy (push) Successful in 2m25s
Details
E2E Playwright Tests / Run Full E2E & Security Suites (push) Failing after 7s
Details
fix(security): remediate audit vulnerabilities SEC-001 through SEC-023
2026-09-23 23:00:25 +03:30
..
audit refactor: unify domain and contact emails to canina.ir across all apps and seeds 2026-08-19 11:52:36 +03:30
01-introduction.md chore(brand): rename all Persian occurrences of کانینا to کنینا across the project 2026-08-16 16:40:08 +03:30
02-user-guide.md chore(brand): rename all Persian occurrences of کانینا to کنینا across the project 2026-08-16 16:40:08 +03:30
03-developer-guide.md feat: rename brand from canina to canino across codebase 2026-07-10 16:32:31 +03:30
04-setup-and-deployment.md refactor: unify domain and contact emails to canina.ir across all apps and seeds 2026-08-19 11:52:36 +03:30
05-devops-and-monitoring.md feat: rename brand from canina to canino across codebase 2026-07-10 16:32:31 +03:30
06-testing.md docs: add comprehensive developer documentation 2026-06-12 13:02:27 +03:30
backlog.md feat: complete all section 26 backlog tasks including pet image upload [TASK-26.18] 2026-08-05 15:45:11 +03:30
README.md chore(brand): rename all Persian occurrences of کانینا to کنینا across the project 2026-08-16 16:40:08 +03:30
SECURITY_PRACTICES.md fix(security): remediate audit vulnerabilities SEC-001 through SEC-023 2026-09-23 23:00:25 +03:30

README.md

مستندات توسعه‌دهندگان (Developer Documentation)

به مستندات رسمی سامانه «کنینا ایران» خوش آمدید. این مستندات به منظور راهنمایی توسعه‌دهندگان، مهندسین دواپس و تیم فنی شرکت نوشته شده است و نباید در دسترس کاربران عمومی قرار گیرد.

در این دایرکتوری تمامی ساختارها، معماری‌ها، قوانین کدنویسی و مراحل انتشار (Deployment) به دقت تدوین شده‌اند تا سرعت 온‌بوردینگ (Onboarding) توسعه‌دهندگان جدید افزایش یافته و نگهداری کدهای قدیمی با کمترین ریسک انجام شود.

فهرست مطالب (Table of Contents)

لطفاً بر اساس نیاز خود به هر یک از بخش‌های زیر مراجعه کنید:

  1. معرفی پروژه و معماری (Introduction)

    • پروژه چیست، قابلیت‌های آن کدامند و چرا از این ابزارها (Next.js & NestJS) استفاده شده است.

  2. راهنمای کاربری و نقش‌ها (User Guide)

    • انواع کاربران سیستم (کاربران عادی، تجاری و مدیران) و اینکه هر کدام قادر به انجام چه کارهایی هستند.

  3. راهنمای توسعه‌دهندگان (Developer Guide)

    • (مهم‌ترین بخش برای دولوپرها) ساختار پوشه‌ها، استانداردهای کدنویسی، مدیریت State و قوانین توسعه بک‌اند و فرانت‌اند.

  4. راه‌اندازی و انتشار سیستم (Setup & Deployment)

    • نحوه اجرای محیط دولوپ روی سیستم شخصی، روند خروجی گرفتن (Build) و دستورات سرور پروداکشن با استفاده از PM2 و Nginx.

  5. دواپس و مانیتورینگ سیستم (DevOps & Monitoring)

    • مدیریت و بررسی سلامت سرور، لاگ‌گیری و خودکارسازی دیپلوی (CI/CD).

  6. راهنمای تست سیستم (Software Testing)

    • انواع تست‌هایی که روی فرانت‌اند و بک‌اند انجام می‌گیرد و نحوه اجرای آن‌ها برای تضمین کیفیت کدها.

توجه: در صورت اضافه شدن ماژول‌ها و ابزارهای جدید به پروژه، لطفاً مستندات مربوطه را در همین پوشه بروزرسانی نمایید.