Documentation Index
Fetch the complete documentation index at: https://docs.twenty.com/llms.txt
Use this file to discover all available pages before exploring further.
المتطلبات الأساسية
Linux و macOS
ويندوز (WSL)
قبل أن تتمكن من تثبيت واستخدام Twenty، تأكد من تثبيت الأمور التالية على جهاز الكمبيوتر الخاص بك:لن يعمل npm ، يجب عليك استخدام yarn بدلًا من ذلك. يأتي Yarn الآن مع Node.js، لذا لست بحاجة إلى تثبيته بشكل منفصل.
عليك فقط تشغيل corepack enable لتفعيل Yarn إذا لم تقم بذلك بعد.
- ثبّت WSL
افتح PowerShell كمسؤول ثم نفّذ:
يجب أن ترى الآن مطالبة لإعادة تشغيل جهاز الكمبيوتر الخاص بك. إذا لم يكن كذلك، فأعد تشغيله يدويًا.عند إعادة التشغيل، ستُفتح نافذة PowerShell وسيتم تثبيت Ubuntu. قد يستغرق هذا وقتًا طويلاً.
سترى مطالبة لإنشاء اسم المستخدم وكلمة المرور لتثبيت Ubuntu الخاص بك.
- تثبيت وإعداد git
sudo apt-get install git
git config --global user.name "Your Name"
git config --global user.email "youremail@domain.com"
- تثبيت nvm و node.js و yarn
استخدم nvm لتثبيت نسخة node الصحيحة. الملف .nvmrc يضمن استخدام جميع المشاركين لنفس النسخة.
sudo apt-get install curl
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
nvm install # يثبت إصدار node الموصى به
nvm use # استخدم إصدار node الموصى به
corepack enable
الخطوة 1: استنساخ Git
في الطرفية الخاصة بك، قم بتشغيل الأمر التالي.
إذا لم تكن قد أعددت مفاتيح SSH بالفعل، يمكنك معرفة كيفية القيام بذلك هنا.git clone git@github.com:twentyhq/twenty.git
git clone https://github.com/twentyhq/twenty.git
الخطوة 2: انتقل إلى جذر المشروع
يجب تشغيل جميع الأوامر في الخطوات التالية من جذر المشروع.
الخطوة 3: إعداد قاعدة بيانات PostgreSQL
Linux
نظام Mac OS
ويندوز (WSL)
الخيار 1 (المفضل): لتوفير قاعدة بياناتك محليًا:
استخدم الرابط التالي لتثبيت PostgreSQL على جهاز Linux الخاص بك: تثبيت PostgreSQL psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
sudo -u postgres إلى الأمر قبل psql لتجنب أخطاء الإذن.الخيار 2: إذا كنت قد قمت بتثبيت docker: make -C packages/twenty-docker postgres-on-docker
الخيار 1 (المفضل): لتوفير قاعدة بياناتك محليًا مع brew:brew install postgresql@16
export PATH="/opt/homebrew/opt/postgresql@16/bin:$PATH"
brew services start postgresql@16
psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
postgres افتراضيًا عند التثبيت
عبر Homebrew على macOS. بدلاً من ذلك، فإنه ينشئ دور PostgreSQL يطابق
اسم المستخدم الخاص بك في MacOS (مثل “john”).
للتحقق وإنشاء المستخدم postgres إذا لزم الأمر، اتبع هذه الخطوات:# قم بالاتصال بPostgreSQL
psql postgres
أو
psql -U $(whoami) -d postgres
# قائمة الأدوار الموجودة في PostgreSQL
\du
اسم الأدوار | الخصائص | عضو في
-----------+-------------+-----------
john | مشرف نظام | {}
postgres مدرجًا، انتقل إلى الخطوة التالية.
قم بإنشاء دور postgres يدويًا:CREATE ROLE postgres WITH SUPERUSER LOGIN;
postgres مع إمكانية تسجيل الدخول.اسم الدور | الخصائص | عضو في
-----------+-------------+-----------
postgres | مشرف نظام | {}
john | مشرف نظام | {}
make -C packages/twenty-docker postgres-on-docker
يجب أن تُنفذ جميع الخطوات التالية في تيرمينال WSL (داخل جهازك الافتراضي)الخيار 1: لتوفير قاعدة بيانات PostgreSQL الخاصة بك محليًا:
استخدم الرابط التالي لتثبيت PostgreSQL على جهاز Linux الافتراضي الخاص بك: تثبيت PostgreSQL psql postgres -c "CREATE DATABASE \"default\";" -c "CREATE DATABASE test;"
sudo -u postgres إلى الأمر قبل psql لتجنب أخطاء الإذن.الخيار 2: إذا كنت قد قمت بتثبيت docker:
تشغيل Docker على WSL يضيف طبقة إضافية من التعقيد.
استخدم هذا الخيار فقط إذا كنت مرتاحًا مع الخطوات الإضافية المتضمنة، بما في ذلك تشغيل Docker Desktop WSL2. make -C packages/twenty-docker postgres-on-docker
localhost:5432.
إذا استخدمت خيار Docker أعلاه، فإن بيانات الاعتماد الافتراضية هي اسم المستخدم postgres وكلمة المرور postgres. بالنسبة لتثبيتات PostgreSQL الأصلية، استخدم بيانات الاعتماد والأدوار المُكوَّنة على جهازك.
الخطوة 4: إعداد قاعدة بيانات Redis (للتخزين المؤقت)
يتطلب Twenty مخزن بيانات Redis لتقديم أفضل أداء.
Linux
Mac OS
ويندوز (WSL)
الخيار 1: لتوفير Redis الخاص بك محليًا:
استخدم الرابط التالي لتثبيت Redis على جهاز Linux: تثبيت Redisالخيار 2: إذا كنت قد قمت بتثبيت docker: make -C packages/twenty-docker redis-on-docker
الخيار 1 (المفضل): لتوفير Redis الخاص بك محليًا مع brew:ابدأ تشغيل خادم Redis:brew services start redis
make -C packages/twenty-docker redis-on-docker
الخيار 1: لتوفير Redis الخاص بك محليًا:
استخدم الرابط التالي لتثبيت Redis على جهاز Linux الافتراضي الخاص بك: تثبيت Redisالخيار 2: إذا كنت قد قمت بتثبيت docker: make -C packages/twenty-docker redis-on-docker
الخطوة 5: إعداد متغيرات البيئة
استخدم متغيرات البيئة أو ملفات .env لتكوين مشروعك. المزيد من المعلومات هنا.
انسخ ملفات .env.example الموجودة في /front و/server:
cp ./packages/twenty-front/.env.example ./packages/twenty-front/.env
cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env
وضع تعدد مساحات العمل: بشكل افتراضي، يعمل Twenty في وضع مساحة عمل واحدة حيث يمكن إنشاء مساحة عمل واحدة فقط. لتمكين دعم تعدد مساحات العمل (مفيد لاختبار الميزات المعتمدة على النطاقات الفرعية)، عيّن IS_MULTIWORKSPACE_ENABLED=true في ملف الخادم .env. راجع وضع تعدد مساحات العمل للحصول على التفاصيل. الخطوة 6: تثبيت التبعيات
لبناء خادم Twenty وزرع بعض البيانات في قاعدة البيانات الخاصة بك، قم بتشغيل الأمر التالي:
لاحظ أن npm أو pnpm لن تعملا
الخطوة 7: تشغيل المشروع
Linux
نظام Mac OS
ويندوز (WSL)
اعتمادًا على توزيعة Linux الخاصة بك، قد يتم بدء خادم Redis تلقائيًا.
إذا لم يكن كذلك، تحقق من دليل تثبيت Redis لتوزيعتك. من المفترض أن يكون Redis قد تم تشغيله بالفعل. إذا لم يكن كذلك، قم بتشغيل:brew services start redis
اعتمادًا على توزيعة Linux الخاصة بك، قد يتم بدء خادم Redis تلقائيًا.
إذا لم يكن كذلك، تحقق من دليل تثبيت ريديس لتوزيعتك. npx nx database:reset twenty-server
npx nx start twenty-server
npx nx worker twenty-server
npx nx start twenty-front
الخطوة الثامنة: استخدم Twenty
الواجهة الأمامية
ستكون واجهة Twenty الأمامية تعمل على http://localhost:3001.
يمكنك تسجيل الدخول باستخدام حساب العرض التوضيحي الافتراضي: tim@apple.dev (كلمة المرور: tim@apple.dev)
الخلفية
استكشاف الأخطاء وإصلاحها
إذا واجهت أي مشكلة، فارجع إلى استكشاف الأخطاء وإصلاحها للحصول على الحلول.