charticulator

แผนภูมิ

Charticulator เป็นเครื่องมือสร้างแผนภูมิใหม่ที่ช่วยให้คุณออกแบบแผนภูมิโดยระบุข้อจำกัดแบบโต้ตอบได้

ทีมงานโครงการ

• ตงห่าว เร็น

• บงชิน ลี

• แมทธิว เบรห์เมอร์

• นาธาน อีแวนส์

• เคท ลิทวีเน็ตส์

• เดวิด ทิตส์เวิร์ธ

• คริส เทรวิโน

สร้าง

ทำตามขั้นตอนต่อไปนี้เพื่อเตรียมสภาพแวดล้อมการพัฒนา:

• ติดตั้ง nodejs 8.0+: https://nodejs.org/

• ติดตั้งเส้นด้าย js 1.7+: https://yarnpkg.com/

ติดตั้งโมดูลโหนด:

 เส้นด้าย

คัดลอกไฟล์การกำหนดค่าเทมเพลตและแก้ไขเนื้อหา:

 cp config.template.yml config.yml# (บน windows ให้ใช้การคัดลอกแทน cp)

รันคำสั่งต่อไปนี้เพื่อสร้าง Charticulator ซึ่งจะสร้างบันเดิลในตัวเองในโฟลเดอร์ dist :

 สร้างเส้นด้าย

เรียกใช้เว็บเซิร์ฟเวอร์ท้องถิ่นเพื่อทดสอบ Charticulator:

 # ให้บริการ Charticulator ที่ http://localhost:4000yarn server# ให้บริการ Charticulator แบบสาธารณะที่ http://0.0.0.0:4000# ใช้สิ่งนี้หากคุณต้องการเปิดใช้งานการเข้าถึงจากคอมพิวเตอร์เครื่องอื่น public_server

การพัฒนา

สำหรับสภาพแวดล้อมการพัฒนาแบบสด ให้รันคำสั่งต่อไปนี้:

 เส้นด้ายเริ่มต้น

คำสั่งนี้จะคอยเฝ้าดูการเปลี่ยนแปลงใน src/ และ sass/ และคอมไพล์ Charticulator ใหม่โดยอัตโนมัติ เมื่อสิ่งนี้เกิดขึ้น ให้เปิด http://localhost:4000/ เพื่อเปิด Charticulator ตอนนี้เมื่อคุณเปลี่ยนซอร์สโค้ด คุณสามารถอัปเดตแอปได้เพียงแค่รีเฟรชหน้าเบราว์เซอร์ (คุณอาจต้องปิดการใช้งานแคชของเบราว์เซอร์)

ในโหมดการพัฒนา จะมีแอปพลิเคชันทดสอบสำหรับส่วนประกอบ UI ซึ่งสามารถเข้าถึงได้ที่ http://localhost:4000/test.html

โหมดนาฬิกาจะไม่อัปเดตเมื่อคุณเปลี่ยนแปลงสิ่งต่อไปนี้:

• config.yml

• THIRD_PARTY.yml

• เว็บแพ็ค.config.js

เมื่อคุณอัปเดตสิ่งเหล่านี้ โปรด yarn build อีกครั้ง

ชุดข้อมูลตัวอย่าง

คุณสามารถเพิ่มชุดข้อมูลตัวอย่างแบบกำหนดเองที่สามารถใช้กับ Charticulator ได้ ในการทำเช่นนั้น ให้สร้างโฟลเดอร์ datasets ที่รากของที่เก็บ (หากไม่มี) เพิ่ม .csv ของคุณ (หรือ .tsv ) ลงในโฟลเดอร์นั้น และสุดท้ายสร้างไฟล์ files.json ในโฟลเดอร์โดยมีสิ่งต่อไปนี้ เนื้อหา:

[
    {
        "name": "<Your dataset display name>",
        "description": "<Your dataset desription>",
        "tables": [
            {
                "name": "<Your dataset file name without extension>",
                "type": "<csv || tsv>",
                "url": "<Your dataset file name with extension>"
            }
        ]
    }
]

การทดสอบ

ปัจจุบัน Charticulator มีรหัสทดสอบพื้นฐาน:

 การทดสอบเส้นด้าย

จำเป็นต้องมีกรณีทดสอบเพิ่มเติม

มีส่วนร่วม

โครงการนี้ยินดีรับการสนับสนุนและข้อเสนอแนะ การบริจาคส่วนใหญ่กำหนดให้คุณยอมรับข้อตกลงใบอนุญาตผู้ร่วมให้ข้อมูล (CLA) โดยประกาศว่าคุณมีสิทธิ์ที่จะให้สิทธิ์แก่เราในการใช้การบริจาคของคุณจริงๆ สำหรับรายละเอียด โปรดไปที่ https://cla.microsoft.com

เมื่อคุณส่งคำขอดึง CLA-bot จะกำหนดโดยอัตโนมัติว่าคุณจำเป็นต้องจัดเตรียม CLA และตกแต่ง PR อย่างเหมาะสมหรือไม่ (เช่น ป้ายกำกับ ความคิดเห็น) เพียงทำตามคำแนะนำที่ได้รับจากบอท คุณจะต้องทำสิ่งนี้เพียงครั้งเดียวกับ repos ทั้งหมดโดยใช้ CLA ของเรา

โครงการนี้ได้นำหลักจรรยาบรรณของ Microsoft Open Source มาใช้ สำหรับข้อมูลเพิ่มเติม โปรดดูคำถามที่พบบ่อยเกี่ยวกับจรรยาบรรณหรือติดต่อ [email protected] หากมีคำถามหรือความคิดเห็นเพิ่มเติม

เอกสารประกอบ

รัน yarn typedoc เพื่อสร้างหน้าเอกสารประกอบ หน้านี้จะมีอยู่ใน ./docs/charticulator

จุดเริ่มต้นของเอกสารคือหน้าดัชนี {@link "index"}