docman

دوكمان

تطبيق إدارة المستندات

مقدمة

• DocMan هو نظام إدارة المستندات الذي يعرض نقاط النهاية باستخدام API Restful.
• لديها الميزات التالية:
  • تسجيل الدخول
  • اشتراك
  • ابحث عن مستخدم واحد
  • ابحث عن جميع المستخدمين
  • ابحث عن المستندات
  • ابحث عن المستخدمين
  • إنشاء مستندات
  • حذف المستندات والمستخدمين
  • تحديث المستندات والمستخدمين
• يمكن العثور على وثائق API هنا

تبعيات المشروع

التبعيات

• Babel -Cli - يسمح بتشغيل التطبيق في وضع ES6 أثناء الطيران دون الحاجة إلى نقله إلى ES5
• Babel-Preset-ES2015 ، Babel-Preset-Stage-0- توفر هذه الحزم مسبقات بابل للإضافات ES2015 ، والمرحلة 0 الإضافات
• Bcryptjs - تستخدم لكلمات مرور التجزئة
• PODY -PARSER - NODE.JS تحليل الوسيطة. تحليل أجسام الطلب الواردة في الوسيطة قبل معالجاتك ، متوفرة تحت خاصية req.body .
• dotenv - تحميل متغيرات البيئة
• Express - يستخدم كخادم الويب لهذا التطبيق
• JSONWEBTOKN - يولد رموز JWT ويمكنها التحقق منها
• PG - عميل PostgreSQL غير المحظور لـ Node.js. JavaScript النقي وترابط libpq الأصلية الاختيارية
• Sequelize - Sequelize عبارة عن Node.js Orm القائم على الوعد لـ Postgres و MySQL و SQLite و Microsoft SQL Server. إنه يتميز بدعم المعاملات الصلبة والعلاقات وقراءة النسخ المتماثل والمزيد

تبعيات التنمية

• Chai - Chai هي مكتبة تأكيد BDD / TDD للعقدة والمتصفح الذي يمكن إقرانه بشكل مبهج مع أي إطار اختبار JavaScript.
• Coveralls - Coveralls.io دعم Node.js. احصل على تقارير التغطية الرائعة لـ Coveralls.io وأضف زر تغطية رائع إلى ReadMe.
• Gulp - Gulp عبارة عن مجموعة أدوات تساعدك على أتمتة المهام المؤلمة أو التي تستغرق وقتًا طويلاً في سير عمل التنمية.
• Gulp -Babel - استخدم الجيل التالي JavaScript ، اليوم ، مع بابل
• Gulp Binject-Modules- يقوم بتحميل ملفات JavaScript عند الطلب من دفق Gulp في وحدة تحميل وحدة Node.
• اسطنبول - يولد تغطية الاختبار
• Gulp-Spawn-Mocha- اتصل بـ Mocha-Cli من Gulp
• Mocha - JavaScript Test Framwork
• Gulp -Nodemon - إنه Gulp + Nodemon + الراحة
• Sequelize -Cli - واجهة سطر الأوامر Sequelize (CLI)
• Supertest - تأكيدات HTTP جعلت سهلة عبر superagent.

التثبيت والإعداد

• انتقل إلى دليل باستخدام terminal المفضلة لديك.

• استنساخ هذا المستودع لهذا الدليل.

• باستخدام SSH ؛ $ git clone [email protected]:andela-obamidele/docman.git

• باستخدام HTTP ؛ $ git clone https://github.com/andela-obamidele/docman.git

• انتقل إلى دليل الريبو

• $ cd document-manager

• تثبيت تبعيات التطبيق

• $ npm install

• تشغيل التطبيق

• $ npm start

الاختبارات

• تمت كتابة الاختبارات باستخدام Supertest ، Chai.
• يتم إنشاء تغطية الاختبار بواسطة حزمة istanbul
• لتشغيل الاختبارات ، انتقل إلى دليل الجذر للمشروع
• تشغيل الأوامر التالية.
• $ npm test

كيفية المساهمة

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

تنصل

يقتصر هذا التطبيق ووظائفه على قيود الوقت وليس بأي حال من الأحوال في أفضل حالاته.

الأسئلة الشائعة

• كيف أساهم في هذا المشروع
  • اقرأ الويكي
  • مفترق ريبو ورفع طلب سحب عندما تكون دوبي
• كم من الوقت سيتم دعم واجهة برمجة التطبيقات هذه
  • طالما أن هناك مستخدمون
• كيف يمكنني الإبلاغ عن خطأ
  • رفع مشكلة تخبرك بما كنت تحاول القيام به عندما حدث الخطأ
  • ورسالة الخطأ

رخصة

الترخيص المدرج في المستودع

مؤلف

Olufisayo Bamidele