trello tresor

Tresor

️ WIP ️

Alat untuk mengambil data dari Trello API dan menyimpannya secara lokal sebagai file JSON statis .

Dengan Tresor Anda dapat menggunakan Trello sebagai UI redaksional dan sistem manajemen konten. Ini akan mengubah daftar Trello menjadi sekumpulan file JSON statis yang siap disajikan sebagai API untuk situs web statis.

Mengapa ?

Ini adalah alat untuk membangun proyek JAMstack Anda berikutnya, memungkinkan basis kode Anda sepenuhnya statis dan tanpa server , tetapi juga memiliki keunggulan sistem manajemen konten, karena situs Anda akan diperbarui secara otomatis ketika konten berubah. Basis kode file statis dapat dihosting seluruhnya di CDN, sehingga mengurangi biaya infrastruktur serta meningkatkan kinerja dan ketersediaan.

Trello menawarkan UI yang sangat sederhana dan API yang dirancang dengan baik, dengan semua fitur yang diperlukan untuk mengelola konten di balik situs web statis kecil, blog, atau aplikasi satu halaman:

• Dukungan penurunan harga
• Lampiran: mengunggah file, merender gambar dalam resolusi berbeda, dan merender thumbnail
• Label: dapat digunakan sebagai tag atau kategori
• Anggota: dapat digunakan untuk menetapkan entri ke penulis
• Dukungan emoji!
• ...

Bagaimana cara kerjanya?

Tresor membaca Trello API dan menyimpan hasilnya secara lokal sebagai file JSON statis, dalam struktur folder yang memungkinkan penggunaan data sebagai titik akhir HTTP API. File statis dapat disalin di folder build klien atau dihosting di tempat lain (CDN, Halaman Github, Netlify, ...), sehingga klien kemudian dapat menggunakan data dengan cara yang tenang.

Menyiapkan Pengiriman Berkelanjutan memungkinkan untuk mengonfigurasi Webhook untuk memicu build baru ketika konten yang disajikan dari API Anda diubah.

Instalasi

(Lewati ini menggunakan npx)

Persyaratan:

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

Berlari:

npm install tresor

Penggunaan

Persyaratan:

• Kunci API Trello dan Token API : dapat diminta di sini
• ID daftar (kolom) untuk diubah menjadi sekumpulan file JSON statis. Misalnya, jika Anda ingin mengerjakan daftar Publik dari papan https://trello.com/b/dhhEnV8b/tresor-example, cukup buka representasi JSON di https://trello.com/b/dhhEnV8b.json dan cari daftar Publik . Anda akan menemukan ID pada objek seperti berikut: {"name":"Public","id":"5b193b1a8a23ebb893ab7a02"}

Anda dapat meneruskan Kunci API, Token API, ID daftar, dan opsi lainnya sebagai:

• variabel lingkungan
• argumen baris perintah
• milik file config.json

Jalankan perintah berikut untuk mengunduh file JSON :

tresor

Meneruskan opsi konfigurasi sebagai variabel lingkungan:

API__KEY=asenoiuwqeWNEUfnewoeFNWQetr3295023rer API__TOKEN=ASnqoiwqenmNEWOIWNrffnklef3io2r032rnewfoid3T439543 API__LIST=124f9hue2983232rj32052s tresor

atau sebagai argumen baris perintah:

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

Pilihan

Opsi yang dapat Anda tambahkan ke file config.json atau meneruskan melalui variabel baris perintah/lingkungan adalah:

Nama	Keterangan	Bawaan
api.url	Url API dasar	"https://api.trello.com/1/"
api.key	Kunci API ( wajib )
api.token	Token API ( wajib )
api.list	ID (sebagai array) dari daftar trello yang akan ditonton ( wajib )
tujuan.root	Folder tempat semua file JSON disimpan	"static/"
tujuan.semua	Nama file JSON berisi semua entri	"all.json"
tujuan.tags	Nama file JSON berisi semua tag	"tags.json"
tujuan.posting	Nama folder tempat semua postingan disimpan	"post"
tujuan.tag	Nama folder tempat semua tag tunggal disimpan	"tag"
gambar tujuan	Nama folder tempat semua gambar akan disimpan	false (jangan unduh gambar)
bidang.bidang	Bidang posting yang akan ditampilkan	["id", "name", "dateLastActivity", "desc", "idList", "labels"]
bidang.anggota	Menampilkan atau tidak informasi pengguna (benar atau salah)	true
bidang.member_fields	Bidang pengguna yang akan ditampilkan	["fullName", "bio"]
bidang.lampiran	Menampilkan atau tidak informasi lampiran (benar atau salah)	true
bidang.attachment_fields	Bidang lampiran yang akan ditampilkan	["previews", "url"]
pagination.entriesPerPage	Jumlah entri dalam satu JSON	20

File config.json default terlihat seperti berikut:

{
    "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
    }
}

Untuk mendapatkan informasi lebih lanjut tentang bidang yang dapat Anda pilih, silakan lihat kartu, lampiran, dan dokumentasi pengguna.

npx

Modul ini cocok digunakan dengan npx , sehingga Anda tidak perlu menginstal modul dan menambahkannya ke dependensi paket Anda. Cukup tambahkan npx tresor ke hook prebuild Anda di package.json modul Anda:

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

Selesai!

Membantu

Menjalankan tresor --help akan mencetak panduan penggunaan berikut:

$ 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