Charticulator adalah alat pembuatan bagan baru yang memungkinkan Anda mendesain bagan dengan menentukan batasan secara interaktif.
Ikuti langkah-langkah berikut untuk mempersiapkan lingkungan pengembangan:
Instal modul simpul:
yarn
Salin file konfigurasi template dan edit isinya:
cp config.template.yml config.yml
# (on windows, use copy instead of cp)
Jalankan perintah berikut untuk membangun Charticulator, yang akan membuat bundel mandiri di folder dist
:
yarn build
Jalankan server web lokal untuk menguji Charticulator:
# Serve Charticulator at http://localhost:4000
yarn server
# Serve Charticulator publicly at http://0.0.0.0:4000
# Use this if you want to enable access from another computer
yarn public_server
Untuk lingkungan pengembangan langsung, tetap jalankan perintah berikut:
yarn start
Perintah ini mengawasi setiap perubahan pada src/
dan sass/
, dan mengkompilasi ulang Charticulator secara otomatis. Setelah ini, buka http://localhost:4000/ untuk meluncurkan Charticulator. Sekarang ketika Anda mengubah kode sumber, aplikasi dapat diperbarui hanya dengan menyegarkan halaman browser (Anda mungkin perlu menonaktifkan cache browser).
Dalam mode pengembangan, terdapat aplikasi pengujian komponen UI yang dapat diakses di http://localhost:4000/test.html.
Mode jam tangan tidak akan diperbarui jika Anda mengubah hal berikut:
Saat Anda memperbarui ini, lakukan yarn build
lagi.
Anda dapat menambahkan kumpulan data sampel khusus yang dapat digunakan dengan Charticulator. Untuk melakukannya, buat folder datasets
di root repositori (jika tidak ada), tambahkan .csv
(atau .tsv
) Anda ke folder itu, dan terakhir buat file files.json
di folder dengan yang berikut ini isi:
[
{
"name": "",
"description": "",
"tables": [
{
"name": "",
"type": "",
"url": ""
}
]
}
]
Charticulator saat ini menyertakan kode pengujian yang belum sempurna:
yarn test
Dibutuhkan lebih banyak kasus uji.
Proyek ini menyambut baik kontribusi dan saran. Sebagian besar kontribusi mengharuskan Anda menyetujui Perjanjian Lisensi Kontributor (CLA) yang menyatakan bahwa Anda berhak, dan memang benar, memberi kami hak untuk menggunakan kontribusi Anda. Untuk detailnya, kunjungi https://cla.microsoft.com.
Saat Anda mengirimkan permintaan tarik, bot CLA akan secara otomatis menentukan apakah Anda perlu memberikan CLA dan menghias PR dengan tepat (misalnya, label, komentar). Cukup ikuti instruksi yang diberikan oleh bot. Anda hanya perlu melakukan ini sekali di seluruh repo menggunakan CLA kami.
Proyek ini telah mengadopsi Kode Etik Sumber Terbuka Microsoft. Untuk informasi lebih lanjut lihat FAQ Pedoman Perilaku atau hubungi [email protected] jika ada pertanyaan atau komentar tambahan.
Jalankan yarn typedoc
untuk menghasilkan halaman dokumentasi. Halaman ini akan tersedia di ./docs/charticulator
Titik awal dokumentasi adalah halaman indeks {@link "index"}