المتطلبات

ما تحتويه كل حزمة

لا تتضمن حزمة التطبيق الواحد التطبيقات الأخرى. يقرأ الموقع ولوحة التحكم كل شيء من واجهة Velra API، وكود واجهة API موجود فقط في حزمتي الحزمة الكاملة وواجهة API.

باستخدام Docker

• Docker Desktop على macOS أو Windows، أو Docker Engine مع إضافة Compose على Linux، مع Docker Compose 2.24 أو أحدث، وهو ما يتضمنه كل Docker Desktop حاليًا؛ ويطبع docker compose version إصدارك. تبدأ الحزمة الكاملة بأمر docker compose واحد، ويقرأ docker-compose.yml الملف back-end/.env فقط عند وجوده، وهو إعداد ترفضه إصدارات Compose الأقدم.
• اتصال بالإنترنت للبناء الأول، الذي ينزّل الصور الأساسية والاعتماديات.
• لا شيء آخر: يجلب Docker معه Node.js، وقاعدة البيانات ملف SQLite داخل وحدة تخزين Docker.

باستخدام Docker

• Docker Desktop على macOS أو Windows، أو Docker Engine على Linux. لتطبيقك ملف Dockerfile خاص به؛ ولا حاجة إلى Compose.
• اتصال بالإنترنت للبناء الأول، الذي ينزّل الصورة الأساسية والاعتماديات.

من دون Docker

• Node.js 22 أو أحدث، وهو الإصدار الذي يعلنه كل تطبيق في engines. تعمل صور Docker على Node.js 24. تحقق من إصدارك بالأمر node -v.
• Yarn 4، عبر Corepack. شغّل corepack enable مرة واحدة؛ يثبّت كل تطبيق إصدار Yarn الخاص به في packageManager، فيختار yarn الإصدار الصحيح. إذا لم يكن في Node.js لديك Corepack (Node.js 25 وما بعده لا تضمه)، فثبّته أولًا بالأمر npm install -g corepack.
• لا حاجة إلى حزم عامة.

قاعدة البيانات

لا حاجة إلى خادم قاعدة بيانات. تستخدم واجهة API قاعدة SQLite افتراضيًا، وينشئ yarn seed الملف لك؛ ويستخدم Docker قاعدة SQLite أيضًا. الانتقال إلى MySQL مدعوم بتغيير في الإعدادات، لا بتغيير في الكود.

• استخدم MySQL بدلًا من ذلك

المنافذ

يعمل كل تطبيق على منفذ محلي ثابت. تأكد من أن لا شيء آخر يستخدمها، أو، مع Docker، انقل أحدها باستخدام SITE_PORT أو ADMIN_PORT أو API_PORT في ملف .env بجوار docker-compose.yml.

• المنفذ مستخدم بالفعل

المنفذ

يعمل الموقع على المنفذ 3030 ويتوقع واجهة API على 8000. تأكد من أن لا شيء آخر يستخدمهما.

• المنفذ مستخدم بالفعل

المنفذ

تعمل لوحة التحكم على المنفذ 3031 وتتوقع واجهة API على 8000. تأكد من أن لا شيء آخر يستخدمهما.

• المنفذ مستخدم بالفعل

المنفذ

تعمل واجهة API على المنفذ 8000، وتقبل افتراضيًا الموقع من 3030 ولوحة التحكم من 3031. تأكد من أن لا شيء آخر يستخدم المنفذ 8000.

• المنفذ مستخدم بالفعل

واجهة API للربط

تطبيقك ليس له بيانات خاصة به. يحتاج إلى تشغيل واجهة Velra API وملئها بالبيانات الأولية، ويُضبط عنوانها في .env الخاص به أو يُمرَّر كمعامل بناء. تُباع واجهة API كحزمة مستقلة هي واجهة API، وهي جزء من الحزمة الكاملة.

• اربط واجهة API الخاصة بك

الخدمات الاختيارية

لا يلزم أي من هذه لتشغيل الوكالة محليًا. يُفعَّل كل منها بمتغيراته في .env الخاص بواجهة API؛ والمتغير المعلّق يبقي ميزته معطلة.

لا توجد خدمة بريد أو دفع لإعدادها: تصل الاستفسارات وطلبات المعاينة كإشعارات في لوحة التحكم.

• اضبط هذه الخدمات

الخرائط

ترسم خرائط لوحة التحكم بلاطات OpenFreeMap، ويستخدم بحث الأماكن في محرر العقار خدمة Photon العامة. كلتاهما تحتاج إلى اتصال بالإنترنت ولا تحتاج إلى مفتاح أو حساب؛ ولا تضمن أي منهما التوفر، ويمكنك توجيههما إلى خدماتك الخاصة.

• إعدادات الخريطة