outline
v0.81.1
قاعدة معرفية سريعة وتعاونية لفريقك تم إنشاؤها باستخدام React وNode.js.
جرب Outline باستخدام نسختنا المستضافة على www.getoutline.com. 
هذا هو الكود المصدري الذي يقوم بتشغيل Outline وجميع الخدمات المرتبطة به. إذا كنت تريد استخدام Outline، فلن تحتاج إلى تشغيل هذا الرمز، فنحن نقدم نسخة مستضافة من التطبيق على getoutline.com. يمكنك أيضًا العثور على وثائق حول استخدام المخطط التفصيلي في دليلنا.
إذا كنت ترغب في تشغيل نسختك الخاصة من Outline أو المساهمة في التطوير، فهذا هو المكان المناسب لك.
يرجى الاطلاع على الوثائق الخاصة بتشغيل نسختك الخاصة من Outline في تكوين الإنتاج.
إذا كانت لديك أسئلة أو تحسينات للمستندات، فيرجى إنشاء موضوع في مناقشات GitHub.
يوجد دليل مختصر لإعداد بيئة التطوير إذا كنت ترغب في المساهمة بالتغييرات والإصلاحات والتحسينات في Outline.
تم إنشاء المخطط التفصيلي وصيانته بواسطة فريق صغير - ونحن نرغب في مساعدتك لإصلاح الأخطاء وإضافة الميزات!
قبل إرسال طلب سحب، يرجى المناقشة مع الفريق الأساسي من خلال إنشاء مشكلة على GitHub أو التعليق عليها - ونود أيضًا أن نسمع منك في المناقشات. بهذه الطريقة يمكننا التأكد من الاتفاق على النهج قبل كتابة التعليمات البرمجية. سيؤدي هذا إلى زيادة احتمالية قبول الكود الخاص بك.
إذا كنت تبحث عن طرق للبدء، فإليك قائمة بالطرق التي تساعدنا في تحسين Outline:
good first issueإذا كنت مهتمًا بالمساهمة أو معرفة المزيد حول قاعدة بيانات Outline، فيرجى الرجوع إلى مستند الهندسة أولاً للحصول على نظرة عامة عالية المستوى حول كيفية تجميع التطبيق معًا.
أثناء التطوير، يقوم المخطط التفصيلي بإخراج تسجيل بسيط إلى وحدة التحكم، مسبوقًا بالفئات. في مرحلة الإنتاج، يقوم بإخراج سجلات JSON، والتي يمكن تحليلها بسهولة من خلال مسار استيعاب السجل المفضل لديك.
يتم تعطيل تسجيل HTTP بشكل افتراضي، ولكن يمكن تمكينه عن طريق تعيين متغير البيئة DEBUG=http .
نحن نهدف إلى الحصول على تغطية اختبارية كافية للأجزاء المهمة من التطبيق ولا نهدف إلى تغطية اختبار الوحدة بنسبة 100%. يجب اختبار جميع نقاط نهاية واجهة برمجة التطبيقات (API) وأي شيء متعلق بالمصادقة بدقة.
لإضافة اختبارات جديدة، اكتب اختباراتك باستخدام Jest وأضف ملفًا بامتداد .test.js بجوار الكود الذي تم اختباره.
# To run all tests
make test
# To run backend tests in watch mode
make watch بمجرد إنشاء قاعدة بيانات الاختبار باستخدام make test يمكنك تشغيل اختبارات الواجهة الأمامية والخلفية بشكل فردي مباشرةً.
# To run backend tests
yarn test:server
# To run a specific backend test
yarn test:server myTestFile
# To run frontend tests
yarn test:appيتم استخدام Sequelize لإنشاء وتشغيل عمليات الترحيل، على سبيل المثال:
yarn sequelize migration:generate --name my-migration
yarn sequelize db:migrateأو لتشغيل عمليات الترحيل على قاعدة بيانات الاختبار:
yarn sequelize db:migrate --env testالمخطط التفصيلي مرخص من BSL 1.1.
