ดาวน์โหลด BEEQ - BEEQ Source Source Download

BEEQ

ส่วนประกอบของบุคคลที่สาม

v1.8.1

ดาวน์โหลด

Beeq ริเริ่มไลบรารีส่วนประกอบเว็บ

ที่เก็บนี้ถือซอร์สโค้ดของส่วนประกอบเว็บที่มีอยู่ในระบบออกแบบ Beeq

บรรจุุภัณฑ์	รุ่น	เอกสาร
`@beeq/core`		readme
`@beeq/angular`		readme
`@beeq/react`		readme
`@beeq/vue`		readme
`@beeq/tailwindcss`		readme

ก่อนเริ่ม

โครงสร้าง ?

โครงการได้รับการจัดโครงสร้างเป็น NX monorepo:

 ├── ? packages
  ├── ? beeq
  ├── ? beeq-angular
  ├── ? beeq-react
  ├── ? beeq-vue
  ├── ...
  ├── ? beeq-tailwindcss
  ├── ...
├── ? tools
├── package.json
├── package-lock.json

ที่ไหน:

แพ็คเกจ/Beeq: Core Library (แหล่งที่มาสำหรับองค์ประกอบ/ส่วนประกอบทั้งหมดที่นำไปใช้)
แพ็คเกจ/Beeq-Angular: wrapper เฉพาะเชิงมุมสำหรับ Library core beeq
แพ็คเกจ/beeq-react: react.js wrapper เฉพาะสำหรับ Library core beeq
แพ็คเกจ/beeq-vue: vue.js wrapper เฉพาะสำหรับ Library core beeq
แพ็คเกจ/beeq-tailwindcss: การกำหนดค่า tailwindcss ที่มีความคิดเห็นของ Beeq

การพึ่งพา?

เราขอแนะนำให้ใช้ Volta เพื่อจัดการเวอร์ชันโหนดและ NPM กระบวนการติดตั้งนั้นค่อนข้างตรงไปตรงมาและตามที่อ้างอิงในเว็บไซต์อย่างเป็นทางการของพวกเขา:

ด้วย Volta คุณสามารถเลือกโหนดเอ็นจินหนึ่งครั้งแล้วหยุดกังวลเกี่ยวกับมัน คุณสามารถสลับระหว่างโครงการและหยุดต้องสลับระหว่างโหนดด้วยตนเอง

เมื่อคุณติดตั้ง Volta เมื่อใดก็ตามที่คุณเปลี่ยนเป็นโฟลเดอร์ Beeq ในเครื่องแล้วจะเปลี่ยนเป็นโหนดด้านขวาและเวอร์ชัน NPM ที่ตรึงไว้ใน package.json :

  "volta" : {
    "node" : " 20.11.1 " ,
    "npm" : " 10.4.0 "
  }

Volta ไม่ได้บังคับคุณยังสามารถใช้การตั้งค่าโหนด/NPM ใด ๆ ที่เหมาะกับคุณมากที่สุดเพียงจำไว้ว่าคุณต้องการ:

NodeJS v18.x หรือสูงกว่า
NPM V8 หรือสูงกว่า

การใช้งาน

ส่วนประกอบ Beeq ถูกเผยแพร่ไปยังรีจิสทรีแพ็คเกจ NPM คุณสามารถใช้ @beeq/core หรือ wrappers เฉพาะเฟรมเวิร์ก ( @beeq/angular , @beeq/react ) ขึ้นอยู่กับสแต็กเทคโนโลยีของโครงการของคุณ ตรวจสอบให้แน่ใจว่าคำแนะนำในการใช้งานสำหรับแต่ละแพ็คเกจ:

วิธีใช้แพ็คเกจ @beeq/core
- วิธีใช้แพ็คเกจ @beeq/angular
วิธีใช้แพ็คเกจ @beeq/react
- วิธีใช้แพ็คเกจ @beeq/vue
- วิธีใช้ @beeq/tailwindcss ที่ตั้งไว้ล่วงหน้า

อย่าลังเลที่จะตรวจสอบหนังสือนิทานของเราเพื่อดูส่วนประกอบของ Beeq ทั้งหมดที่ปล่อยออกมา ที่นั่นคุณสามารถค้นหา API ของส่วนประกอบทั้งหมด (คุณสมบัติเหตุการณ์และวิธีการที่เปิดเผย) พร้อมกับความแปรปรวนที่แต่ละองค์ประกอบอนุญาต

กำลังดำเนินโครงการ? ‍

ในการพัฒนา/ขยายส่วนประกอบในระบบการออกแบบ Beeq โปรดแยก repo นี้ใน GitHub และโคลนในท้องถิ่นไปยังไดเรกทอรีใหม่:

git clone https://github.com/ < YOUR_GITHUB_USERNAME > /BEEQ.git BEEQ-Design-System
cd BEEQ-Design-System
git checkout main

การติดตั้ง

เพียงแค่วิ่ง:

npm ci
# Make sure to build first the project before starting it
npm run build
npm start

เริ่มเขียนโค้ด?!

สร้าง ?

สำหรับการสร้างการผลิตเพียงวิ่ง:

npm run build

ทดสอบ ?

Beeq ใช้ jest สำหรับการทดสอบหน่วยและ jest และ puppeteer สำหรับการทดสอบแบบ end-to-end

คุณสามารถเรียกใช้การทดสอบทั้งหมดหนึ่งครั้งโดยดำเนินการ:

npm run test

หากคุณได้รับข้อผิดพลาดคล้ายกับข้อผิดพลาดด้านล่าง ลองตรวจสอบสาขา main ในพื้นที่และเรียกใช้การทดสอบอีกครั้ง

fatal: Not a valid object name main
fatal: No such ref: ' main '
nx affected

สร้างส่วนประกอบ

Beeq มาพร้อมกับตัวสร้างส่วนประกอบที่ช่วยประหยัดเวลาเมื่อสร้างโครงกระดูกสำหรับส่วนประกอบใหม่ ในการใช้เครื่องกำเนิดไฟฟ้าคุณเพียงแค่เรียกใช้คำสั่งต่อไปนี้และทำตามคำแนะนำใน CLI พรอมต์ของคุณ:

npm run g

การบริจาค

- หากคุณอยู่ในอารมณ์และต้องการความช่วยเหลือโปรดอ่านแนวทางการสนับสนุนและมาตรฐานการพัฒนาของเราอย่างรอบคอบ

❗เมื่อทำงานกับการแก้ไขข้อผิดพลาดคุณสมบัติใหม่ ฯลฯ โปรดสังเกตว่าเราทำตามเวิร์กโฟลว์ Gitflow ตรวจสอบให้แน่ใจว่าได้ทำตามคำแนะนำจากแนวทางกลยุทธ์การแตกแขนงที่มีส่วนร่วมเกี่ยวกับวิธีการสร้างสาขาของคุณเมื่อเริ่มทำงานกับการแก้ไขข้อผิดพลาด/ร้อนคุณสมบัติใหม่ ฯลฯ