الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل 


 Free and Open Source 
Full Stack
RAPID API DEVELOPMENT

مدعوم من الاسترجاع والزاوية


عن

Colmena هي مجموعة مبتدئة لواجهة برمجة التطبيقات مع واجهة المسؤول التي يمكن تمديدها بسهولة وبناء عليها.

تم تصميمه باستخدام مجموعة من المشاريع المفتوحة المصدر الرائعة ، بما في ذلك على سبيل المثال لا الحصر:

  • Loopback - API Server بناءً على Express.
  • Angular - MVC Framework لإنشاء تطبيقات الويب.
  • Loopback SDK Builder - تكامل رائع من الاسترجاع والزاوية.
  • Coreui - قالب مسؤول Bootstrap مذهلة.

️ تحذير

هذا البرنامج تحت التطوير النشط!

يرجى عدم استخدامه في الإنتاج دون معالجة المشكلات في قسم العمل الجاري

العمل قيد التقدم

Colmena هو عمل قيد التقدم وليس كل الوظائف التي تم تصميمها بعد.

  • يتم تنفيذ ACL الأساسي فقط ، وهذا يعني أنه يمكن استخدام API من قبل من لديه إمكانية الوصول إليه
  • الواجهة لا تعكس دور المستخدم (المسؤول/المدير/المستخدم)
  • سيكون المحتوى يتسرب عبر المجالات ، في حين أن هذا لا ينبغي أن يكون ممكنًا

بناء

المشروع هو مونو ريبو يديره ليرنا. منظم مثل هذا:

  • apps/
    • admin واجهة المسؤول المبنية مع الزاوي.
    • api API الباقي بنيت مع الاسترجاع.
  • modules/
    • الوحدات admin-* التي تضيف وظائف إلى تطبيق المسؤول.
    • الوحدات api-* التي تضيف وظائف إلى تطبيق API.
  • packages/
    • الحزم admin-* المستخدمة من قبل تطبيق المسؤول.
    • حزم api-* المستخدمة من قبل تطبيق API.

إن بنية هذا المشروع مستوحاة من هذا المثال الرائع: Oasisdigital/قابل للتطوير-enterprise-angular.

تثبيت

متطلبات

البرنامج المثبت على نظامك:

  • node (v6.9.x أو أعلى).
  • npm (V3.x أو أعلى).

حزم العقدة المثبتة عالميا:

  • CLI الزاوي
  • ليرنا
  • Loopback Cli 
npm install -g @angular/cli lerna loopback-cli

يثبت

استنساخ المستودع وتثبيت التبعيات: 

git clone https://github.com/colmena/colmena
cd colmena
npm install
lerna bootstrap

تطوير

تشغيل في وضع التطوير

عند تشغيل المشروع في وضع التطوير ، سيتم إعادة تشغيل API وسيتم إعادة تشغيل المسؤول تلقائيًا عند اكتشاف تغيير الرمز.

عناوين URL

  • يستمع API على http://127.0.0.1:3000.
  • يستمع المسؤول على http://127.0.0.1:9000.

ابدأ المشروع

من داخل مشروع Dir Run npm run dev : 

npm run dev

سيبدأ هذا كل من واجهة برمجة التطبيقات والمشرف في نفس المحطة.

يمكنك أيضًا بدء المكونين بشكل منفصل:

ابدأ واجهة برمجة التطبيقات 

npm run dev:api

ابدأ المشرف 

npm run dev:admin

تنظيف المشروع

أثناء التطوير ، قد يكون من المفيد إعادة المشروع إلى حالة نظيفة. للقيام بهذا المدى: 

npm run clean && npm install && lerna bootstrap

تكوين إعداد التطوير

local.yaml

يمكنك تكوين واجهة برمجة التطبيقات في وضع التطوير عن طريق إنشاء ملف local.yaml في config . لا يتم تتبع محتويات هذا الملف بواسطة GIT ، لذا فهو يعيش فقط على جهازك المحلي.

للبدء بالإعدادات الافتراضية ، نسخ config/default.yaml إلى config/local.yaml .

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

تأتي واجهة برمجة التطبيقات مع مجموعة من بيانات العينة للتطوير.

لتحميل بيانات العينة عند بدء تحديث API local.yaml لتضمين: 

 system :
  initdb : true

يمكنك أيضًا استخدام متغير بيئة INITDB .

url قاعدة API

افتراضيًا ، يفترض مكدس التطوير أن API و Admin قد تم تشغيلهما على المضيف المحلي (باستخدام 127.0.0.1 ).

من أجل تشغيل واجهة برمجة التطبيقات على مضيف آخر من المضيف المحلي ، يحتاج المسؤول إلى معرفة عنوان IP الذي يمكن أن يصل إلى واجهة برمجة التطبيقات. للقيام بذلك ، تحتاج إلى تحديث خاصية api.baseUrl Config.

تأكد من تكوين عنوان URL قاعدة API بدون مائلة زائدة.

لتعيين UPI Base URL Update local.yaml لتضمين: 

 api :
  # Do not use trailing spaces for the baseUrl
  baseUrl : http://192.168.12.34:3000

يمكنك أيضًا استخدام متغير بيئة API_BASE_URL .

يجب أن تكون قادرًا الآن على الاتصال بالمشرف على http://192.168.12.34:9000 ويجب أن يتصل بـ API.

خوادم التنمية

يأتي Colmena مع Docker Compose Configuration لتشغيل خوادم تطوير بسهولة.

mongodb

لاستخدام تحديث خادم MongoDB local.yaml لتضمين: 

 mongodb :
  url : mongodb://localhost/colmena

يمكنك أيضًا استخدام متغير بيئة MONGODB_URL

MailHog

لاستخدام تحديث خادم MailHog local.yaml لتضمين: 

 smtp :
  host : localhost
  port : 1025

يمكنك أيضًا استخدام متغيرات بيئة SMTP_HOST و SMTP_PORT

ابدأ الخوادم 

npm run servers # or: npm run servers:start

إظهار الخوادم التي تسجل 

npm run servers:logs

أوقف الخوادم 

npm run servers:stop

حذف الخوادم 

npm run servers:rm

المساهمين

شكراً لهؤلاء الأشخاص الرائعين (مفتاح الرموز التعبيرية):


برام بورغريف
؟ ؟ ؟
ويليان ريبيرو أنجيلو

نيك بورتكالديس

drmikecrowe

فلاديمير mechkauskas

برناردو أريفالو

yieme

براين ماكنتاير

روب هالف

Asgeir Birkisson

Dthib

أوليه كوكيل

بولكيت سينغال

توان PM

براونمان

Hoàng phúc

براين دنيت

تشنز

Tersius Kuhne

أليكس كويامبو

خوسيه لويس دي بيس

السود.

أليكس وايلد

DMTW

ماركوس

برانون ن. داربي الثاني

سيباستيان بودجاجني

iScaster

يتبع هذا المشروع مواصفات جميع المساهمين. مساهمات من أي نوع ترحيب!

مؤيدون

دعمنا بتبرع شهري ومساعدتنا على مواصلة أنشطتنا. [كن مؤيدًا]

الرعاة

كن راعياً واحصل على شعارك على ReadMe على Github مع رابط لموقعك. [كن راعياً]

كان هذا المشروع يعرف سابقًا باسم المشرف الزاوي لوب.

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل