quickjots

Quickjots

QuickJots เป็นเว็บแอปเพื่อจดบันทึกและบันทึกบันทึกย่อใด ๆ ในเบราว์เซอร์ของคุณโดยใช้ markdown หรือข้อความธรรมดา ไม่จำเป็นต้องลงทะเบียนและมีโหมดมืด!

รองรับทั้งโน้ตข้อความธรรมดาและ markdown (ด้วยความช่วยเหลือของ Showdown)

ที่เก็บนี้มีซอร์สโค้ดทั้งหมดสำหรับเว็บแอปที่ quickjots.app

ปัจจุบัน QuickJots โฮสต์โดยใช้ netlify ดังนั้นจึงมีไฟล์ netlify.toml ในรูทเพื่อกำหนดค่า netlify

เริ่มต้น

หากคุณต้องการมีส่วนร่วมใน QuickJots หรือโฮสต์ด้วยตัวคุณเองคุณจะต้องแยก repo นี้ผ่าน GitHub ตามด้วย:

QuickJots ใช้ WebPack Bundles ซอร์สโค้ดใน repo นี้เข้าด้วยกันในไซต์คงที่ มันใช้พนักงานบริการเพื่อให้การสนับสนุนแบบออฟไลน์

รหัส JavaScript หลักอยู่ใน ./src/js - ไฟล์ทั้งหมดใช้ window.quickjots ฐาน. QUICKJOTS วัตถุและเพิ่มฟังก์ชั่นและตัวแปรที่จำเป็นใด ๆ ในสิ่งนี้

1. git clone [email protected]:[username]/quickjots.git
2. ตรวจสอบให้แน่ใจว่าคุณติดตั้ง node.js (เพื่อรวมไฟล์ด้วย webpack)
3. เรียกใช้ yarn install ในไดเรกทอรีรูท repo เพื่อติดตั้งการพึ่งพา
4. เรียกใช้ yarn start เรียกใช้เซิร์ฟเวอร์ webpack dev บนพอร์ตท้องถิ่น 8080 ของคุณในขณะที่แก้ไขรหัส มันจะโหลดอัตโนมัติในการเปลี่ยนแปลงใด ๆ
5. เรียกใช้ yarn build เพื่อเรียกใช้ webpack ในโหมดการผลิตเพื่อสร้างไฟล์ใน dist/ ไฟล์เหล่านี้มีไซต์คงที่เพื่อให้คุณโฮสต์ตัวเองหากคุณต้องการ

หมายเหตุคุณอาจต้องการปิดการใช้งานผู้ปฏิบัติงานบริการในเดฟ-โหมดหากคุณกำลังทดสอบการเปลี่ยนแปลงมากมายในพื้นที่ไม่เช่นนั้นคุณจะเห็นรหัสเก่าทำงานแทนรหัสใหม่ของคุณ! นอกจากนี้ยังมีตัวเลือก 'Update on Reload' ในเครื่องมือ Chrome Dev สำหรับพนักงานบริการหากคุณไม่ต้องการปิดใช้งานสำหรับ dev-mode

การบริจาค

การมีส่วนร่วมใด ๆ เช่นรายงานข้อผิดพลาดคำขอคุณลักษณะหรือคำขอดึงยินดีต้อนรับ!

มีการกำหนดค่า eslint ใน .eslintrc.json แต่ในระยะสั้นรหัสหลักคือ:

• ใช้การเยื้อง 2 ช่องว่าง
• ใช้พื้นที่สำหรับการเยื้อง
• ใช้เครื่องหมายอัฒภาคในตอนท้ายของงบ
• ใช้ฟังก์ชั่นลูกศรหากเป็นไปได้