หน้าแรก>แหล่งข้อมูลการสร้างเว็บไซต์>ข้อมูลเว็บไซต์
ดาวน์โหลด

crossBILLy - มิคาเอล อเล็กซีว

@alekseew/ crossBILLy

พื้นที่เก็บข้อมูลนี้มีแอปบนเว็บและข้ามแพลตฟอร์ม (Web PWA, Windows, Mac OS X, iOS และ Android) เพื่อให้เรียกเก็บเงินได้ง่าย โปรเจ็กต์นี้น่าจะช่วยรักษาข้อมูลลูกค้า ทำใบแจ้งหนี้/วางบิล ...

เฟรมเวิร์กที่ใช้หรือทดลองใช้ แพลตฟอร์ม ไลบรารี ปลั๊กอิน แนวคิด สถาปัตยกรรม เทคนิค ... มีดังต่อไปนี้:

  • การแยกส่วนการควบคุมแหล่งที่มา - โมเดล: GitFlow
  • แพลตฟอร์ม / กรอบงาน WebApp ส่วนหน้า: เชิงมุม
  • เครื่องมือ / กรอบงานสร้างข้ามแพลตฟอร์ม: ตัวเก็บประจุแบบไอออนิก หรือ คอร์โดวา และ อิเล็กตรอน
  • ภาษาการพัฒนา: typescript / ( JavaScript )
  • ไลบรารี WebApp UI: วัสดุเชิงมุม
  • ไลบรารี "พฤติกรรม" ของ WebApp UI: Angular CDK
  • การจัดรูปแบบโค้ด: สวยกว่า
  • การกำหนดเวอร์ชัน บันทึกการเปลี่ยนแปลงอัตโนมัติ (การเผยแพร่): เวอร์ชันมาตรฐาน
  • เครื่องมือส่งข้อความคอมมิต: คอมมิต
  • เครื่องมือ Git-Hooks: Husky
  • แอนิเมชั่น: Lottie และ Lottie-Web
  • โฮสติ้งและอื่นๆ... : FireBase
  • การบูรณาการอย่างต่อเนื่อง (CI) / การทดสอบและการสร้าง: Travis
  • การตรวจสอบการพึ่งพา: Greenkeeper
  • จะดำเนินต่อไป ...

ข้อกำหนดเบื้องต้น

โปรเจ็กต์นี้จำเป็นต้องติดตั้งการขึ้นต่อกันต่อไปนี้ล่วงหน้า:

  • โหนด js
  • นพีเอ็ม

การพึ่งพาอาศัยกัน

หากต้องการติดตั้งการขึ้นต่อกันที่จำเป็นทั้งหมด ให้รัน: 

npm install

นี่เป็นการตั้งค่าเทมเพลตข้อความคอมไพล์คอมไพล์ด้วย (และตั้งค่าแพ็คเกจ wip เพื่อใช้คอมมิต)

GitFlow

โปรดใช้โมเดลการแยกสาขา GitFlow และชื่อเริ่มต้นสำหรับสาขาของ SourceTree ในโปรเจ็กต์นี้ สามารถดูข้อมูลเพิ่มเติมได้ที่นี่:

  • GitFlow
  • SourceTree + GitFlow

ชื่อสาขาและหลักการตั้งชื่อคำนำหน้า (การตั้งค่าเริ่มต้นใน SourceTree):

  • สาขาการผลิต: ปริญญาโท
  • สาขาพัฒนา: พัฒนา
  • คำนำหน้าสาขาคุณลักษณะ: คุณลักษณะ/
  • คำนำหน้าสาขาที่วางจำหน่าย: release/
  • คำนำหน้าสาขาโปรแกรมแก้ไขด่วน: hotfix/
  • ไม่มีคำนำหน้าแท็กเวอร์ชัน (ชื่อแท็กจะเป็นเช่น v0.1.0)

บันทึกการเปลี่ยนแปลง / ความมุ่งมั่นทั่วไป

ในโครงการนี้ (เชิงมุม) คอมมิตแบบธรรมดาจะใช้ แนวทางข้อความ Angular Commit

พวกมันจะถูกใช้เพื่อสร้างบันทึกการเปลี่ยนแปลงโดยอัตโนมัติด้วยแพ็คเกจ npm standard-version โดยให้รัน npm run release สิ่งนี้จะทำงานดังต่อไปนี้:

  • อัปเดตเวอร์ชันของโครงการ
  • สร้าง / อัปเดต CHANGELOG.md
  • ยอมรับการเปลี่ยนแปลงนี้ (พร้อมที่จะพุชไปยังระยะไกล)
  • สร้างแท็ก git

คุณสามารถใช้ npm run commit เพื่อรับวิซาร์ดที่ช่วยให้คุณเขียนข้อความการคอมมิตที่ถูกต้อง (ซึ่งทำได้ด้วย คอมมิต )

นอกจากนี้ ข้อความการคอมมิตจะถูกตรวจสอบว่าถูกต้องด้วย คอมมิตลินต์ (หากคุณจำเป็นต้องข้ามมันจริงๆ คุณสามารถข้าม Githooks ได้ แต่คุณไม่ควรทำตามปกติ)

คุณสามารถสร้างเทมเพลตข้อความ git commit ด้วย npm run prepare-git-commit-template ซึ่งจะทำระหว่างการติดตั้ง npm ด้วย

ยืนยันรูปแบบข้อความ

ส่วนหัว (ประกอบด้วย ประเภท ขอบเขต และ หัวเรื่อง ) ไม่ควรยาวเกิน 72 อักขระ 

 type(scope?): subject

body?

footer?

พิมพ์

จะต้องเป็นหนึ่งในสิ่งต่อไปนี้:

  • feat : คุณลักษณะใหม่
  • แก้ไข : แก้ไขข้อบกพร่อง
  • docs : เอกสารมีการเปลี่ยนแปลงเท่านั้น
  • style : การเปลี่ยนแปลงที่ไม่ส่งผลต่อความหมายของโค้ด (ช่องว่าง การจัดรูปแบบ เครื่องหมายอัฒภาคที่หายไป ฯลฯ)
  • refactor : การเปลี่ยนแปลงโค้ดที่ไม่แก้ไขข้อบกพร่องหรือเพิ่มคุณสมบัติ
  • perf : การเปลี่ยนแปลงโค้ดที่ปรับปรุงประสิทธิภาพ
  • test : เพิ่มการทดสอบที่ขาดหายไปหรือแก้ไขการทดสอบที่มีอยู่
  • build : การเปลี่ยนแปลงที่ส่งผลต่อระบบ build, การกำหนดค่า CI หรือการพึ่งพาภายนอก (ขอบเขตตัวอย่าง: gulp, broccoli, npm)
  • ci : การเปลี่ยนแปลงไฟล์การกำหนดค่า CI และสคริปต์ของเรา (ขอบเขตตัวอย่าง: Travis, Circle, BrowserStack, SauceLabs)
  • chore : การเปลี่ยนแปลงอื่นๆ ที่ไม่ได้แก้ไข src หรือไฟล์ test
  • revert : คืนค่าการคอมมิตก่อนหน้านี้

ขอบเขต

ขอบเขตอาจเป็นอะไรก็ได้ที่ระบุตำแหน่งของการเปลี่ยนแปลงการกระทำ ฉันกำลังใช้แบบแผนต่อไปนี้ (ตัวอย่าง):

  • all : การเปลี่ยนแปลงสำหรับทั้งโปรเจ็กต์ (การเปิดตัวโปรเจ็กต์ทั่วไป, ...)
  • root : การเปลี่ยนแปลงในรูท (โฟลเดอร์) ของโปรเจ็กต์
  • be : การเปลี่ยนแปลงในส่วนแบ็กเอนด์ของโครงการ
  • fe : การเปลี่ยนแปลงในส่วนส่วนหน้า (webapp) ของโครงการ

เรื่อง

หัวเรื่องมีคำอธิบายโดยย่อของการเปลี่ยนแปลง:

  • ใช้ความจำเป็นกาลปัจจุบัน: "เปลี่ยน" ไม่ใช่ "เปลี่ยน" หรือ "เปลี่ยนแปลง"
  • อย่าใช้อักษรตัวแรกเป็นตัวพิมพ์ใหญ่
  • ไม่มีจุด (.) ต่อท้าย

ร่างกาย

เช่นเดียวกับใน เรื่อง ให้ ใช้กาลปัจจุบันที่จำเป็น: "เปลี่ยน" ไม่ใช่ "เปลี่ยน" หรือ "เปลี่ยนแปลง" ร่างกายควรมีแรงจูงใจในการเปลี่ยนแปลงและเปรียบเทียบกับพฤติกรรมก่อนหน้านี้

ส่วนท้าย

ส่วนท้ายควรมีข้อมูลใดๆ เกี่ยวกับ การทำลายการเปลี่ยนแปลง และยังเป็นที่สำหรับอ้างอิงปัญหาของ JIRA ที่คอมมิตนี้ Closes

Breaking Changes ควรขึ้นต้นด้วยคำว่า BREAKING CHANGE: ด้วยการเว้นวรรคหรือขึ้นบรรทัดใหม่ 2 บรรทัด จากนั้นข้อความคอมมิตที่เหลือจะถูกใช้สำหรับสิ่งนี้

มุ่งมั่น Hooks

ใน repo git hooks นี้ถูกใช้ (ตั้งค่าด้วย husky ) เพื่อตรวจสอบซอร์สโค้ด "สะอาด"

ตรวจสอบรูปแบบที่สวยขึ้น

หากไฟล์ Typescript หรือ SCSS มีการเปลี่ยนแปลงและพุช Commit Hook จะถูกทริกเกอร์และไฟล์ที่จัดฉากจะถูกจัดรูปแบบให้สวยงามยิ่งขึ้น มันทำการฟอร์แมต / เปลี่ยนแปลงและกระทำและผลักดันการเปลี่ยนแปลงนี้ด้วยความช่วยเหลือของ ที่ค่อนข้างรวดเร็ว

ส่งข้อความ Linting

ตรวจสอบว่าข้อความคอมมิตคอมไพล์เป็นข้อความคอมมิตคอมไพล์ทั่วไปหรือไม่ ไม่เช่นนั้นข้อความนั้นจะยกเลิกการคอมมิต

เวอร์ชันของโครงการและการวางจำหน่าย

การคอมมิตครั้งล่าสุดใน release Branch ควรตั้งค่าเวอร์ชันโปรเจ็กต์และสร้าง Changelog ซึ่งควรทำด้วย npm run release ชุดนี้เป็นเวอร์ชันของโปรเจ็กต์ สร้างบันทึกการเปลี่ยนแปลง และ ยืนยันการเปลี่ยนแปลงนี้ สามารถดูข้อมูลเพิ่มเติมได้ในบท: Conventional Changelog / Commits

ดำเนินการบูรณาการและปรับใช้ต่อไป

ในโปรเจ็กต์นี้ Travis CI ได้รับการตั้งค่าเป็น lint-, test-, e2e-tests- และ build-slave หากทุกอย่างได้รับการทดสอบและสร้างได้สำเร็จ Travis CI จะปรับใช้ WebApp กับ FireBase

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด