الصفحة الرئيسية>كود مصدر ASP>فئات أخرى
تنزيل

تريزور

️ قيد التنفيذ ️

أداة لجلب البيانات من Trello API وتخزينها محليًا كملفات JSON ثابتة .

مع Tresor، يمكنك استخدام Trello كواجهة مستخدم منقحة ونظام لإدارة المحتوى. سيقوم بتحويل قائمة Trello إلى مجموعة من ملفات JSON الثابتة الجاهزة لتقديمها كواجهة برمجة التطبيقات (API) لموقع ويب ثابت.

لماذا ؟

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

يقدم Trello واجهة مستخدم بسيطة للغاية وواجهة برمجة تطبيقات مصممة بشكل جيد، مع جميع الميزات الضرورية لإدارة المحتوى خلف موقع ويب ثابت صغير أو مدونة أو تطبيق من صفحة واحدة:

  • دعم تخفيض السعر
  • المرفقات: تحميل الملفات وعرض الصور بدقة مختلفة وعرض الصور المصغرة
  • التسميات: يمكن استخدامها كعلامات أو فئات
  • الأعضاء: يمكن استخدامها لتعيين إدخال للمؤلف
  • دعم الرموز التعبيرية!
  • ...

كيف يعمل ؟

يقرأ Tresor واجهة برمجة تطبيقات Trello ويحفظ النتائج محليًا كملفات JSON ثابتة، في بنية مجلد تسمح باستهلاك البيانات كنقاط نهاية HTTP API. يمكن نسخ الملفات الثابتة في مجلد بناء العميل أو استضافتها في مكان آخر (شبكات CDN، صفحات Github، Netlify، ...)، بحيث يمكن للعميل بعد ذلك استهلاك البيانات بطريقة مريحة.

إعداد التسليم المستمر من الممكن بعد ذلك تكوين Webhook لتشغيل إنشاء جديد عند تغيير المحتوى المقدم من واجهة برمجة التطبيقات الخاصة بك.

تثبيت

(تخطي هذا باستخدام npx)

متطلبات:

  • Node.js >= v8
  • npm >= v5

يجري: 

npm install tresor

الاستخدام

متطلبات:

  • يمكن طلب مفتاح Trello API ورمز واجهة برمجة التطبيقات (API Token ) هنا
  • معرف القائمة (العمود) المطلوب تحويلها إلى مجموعة من ملفات JSON الثابتة. إذا كنت تريد على سبيل المثال العمل في القائمة العامة من اللوحة https://trello.com/b/dhhEnV8b/tresor-example، فما عليك سوى فتح تمثيل JSON على https://trello.com/b/dhhEnV8b.json و ابحث عن القائمة العامة . ستجد المعرف في كائن مثل ما يلي: {"name":"Public","id":"5b193b1a8a23ebb893ab7a02"}

يمكنك تمرير مفتاح API ورمز API ومعرف القائمة وأي خيار آخر على النحو التالي:

  • متغيرات البيئة
  • وسيطات سطر الأوامر
  • خاصية ملف config.json

قم بتشغيل الأمر التالي لتنزيل ملفات JSON : 

tresor

تمرير خيارات التكوين كمتغيرات البيئة: 

API__KEY=asenoiuwqeWNEUfnewoeFNWQetr3295023rer API__TOKEN=ASnqoiwqenmNEWOIWNrffnklef3io2r032rnewfoid3T439543 API__LIST=124f9hue2983232rj32052s tresor

أو كوسيطات سطر الأوامر: 

tresor --api.key=asenoiuwqeWNEUfnewoeFNWQetr3295023rer --api.token=ASnqoiwqenmNEWOIWNrffnklef3io2r032rnewfoid3T439543 --api.list=124f9hue2983232rj32052s

خيارات

الخيارات التي يمكنك إضافتها إلى ملف config.json أو تمريرها عبر متغيرات سطر الأوامر/البيئة هي:

اسم وصف تقصير
api.url عنوان URL الأساسي لواجهة برمجة التطبيقات "https://api.trello.com/1/"
api.key مفتاح API ( مطلوب )
api.token رمز واجهة برمجة التطبيقات ( مطلوب )
api.list المعرفات (كمصفوفة) لقوائم trello المطلوب مشاهدتها ( مطلوب )
dest.root المجلد الذي يتم فيه حفظ جميع ملفات JSON "static/"
dest.all اسم ملف JSON الذي يحتوي على كافة الإدخالات "all.json"
dest.tags اسم ملف JSON يحتوي على جميع العلامات "tags.json"
dest.post اسم المجلد حيث يتم حفظ جميع المشاركات الفردية "post"
dest.tag اسم المجلد الذي يتم حفظ كافة العلامات الفردية فيه "tag"
dest.images اسم المجلد الذي سيتم تخزين كافة الصور فيه false (لا تقم بتنزيل الصور)
الحقول. الحقول حقول المشاركة التي سيتم عرضها ["id", "name", "dateLastActivity", "desc", "idList", "labels"]
الحقول. الأعضاء عرض أو عدم عرض معلومات المستخدم (صواب أو خطأ) true
field.member_fields حقول المستخدم التي سيتم عرضها ["fullName", "bio"]
الحقول.المرفقات عرض أو عدم عرض معلومات المرفقات (صح أو خطأ) true
field.attachment_fields الحقول المرفقة التي سيتم عرضها ["previews", "url"]
pagination.entriesPerPage عدد الإدخالات في JSON واحد 20

يبدو ملف config.json الافتراضي كما يلي: 

{
    "api" : {
        "url" : " https://api.trello.com/1/ "
    },
    "dest" : {
        "root" : " static " ,
        "all" : " pages " ,
        "tags" : " tags " ,
        "tagList" : " tags.json " ,
        "post" : " post " ,
        "tag" : " tag " ,
        "images" : false
    },
    "fields" : {
        "fields" : [ " id " , " name " , " dateLastActivity " , " desc " , " idList " , " labels " ],
        "members" : true ,
        "member_fields" : [ " fullName " , " bio " ],
        "attachments" : true ,
        "attachment_fields" : [ " previews " , " url " ]
    },
    "pagination" : {
        "entriesPerPage" : 20
    }
}

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

npx

هذه الوحدة مناسبة للاستخدام مع npx ، بحيث لا تحتاج إلى تثبيت الوحدة وإضافتها إلى تبعيات الحزمة الخاصة بك. ما عليك سوى إضافة npx tresor إلى خطاف prebuild الخاص بك في package.json الخاص بوحدتك: 

{
  [ ... ]
  "scripts" : {
    "prebuild" : " npx tresor " ,
  [ ... ]
  }
}

منتهي!

يساعد

سيؤدي تشغيل tresor --help إلى طباعة دليل الاستخدام التالي: 

$ tresor --help

  A tool to fetch remote API data and store them locally as static JSON files

  Usage
  $ tresor
  Run tresor

  $ tresor --help
  Print this help message

  $ tresor --version
  Print the current version

  Examples
  $ tresor --api.key=XXX --api.token=XXX --api.list=XXX

  Run the script to request the remote JSON files and save
  them locally.
  You can alternatively pass the configuration options as
  environment variables or writing them to config.json.
  See the online documentation for further information
يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل