outline

ฐานความรู้ที่รวดเร็วและทำงานร่วมกันสำหรับทีมของคุณที่สร้างโดยใช้ React และ Node.js
ลองใช้ Outline โดยใช้เวอร์ชันโฮสต์ของเราที่ www.getoutline.com

นี่คือซอร์สโค้ดที่เรียกใช้ Outline และบริการที่เกี่ยวข้องทั้งหมด หากต้องการใช้ Outline คุณไม่จำเป็นต้องเรียกใช้โค้ดนี้ เรามีแอปเวอร์ชันโฮสต์อยู่ที่ getoutline.com คุณยังดูเอกสารเกี่ยวกับการใช้ Outline ได้ในคำแนะนำของเรา

หากคุณต้องการเรียกใช้ Outline ของคุณเองหรือมีส่วนร่วมในการพัฒนา นี่คือที่สำหรับคุณ

การติดตั้ง

โปรดดูเอกสารประกอบสำหรับการเรียกใช้สำเนา Outline ของคุณเองในการกำหนดค่าที่ใช้งานจริง

หากคุณมีคำถามหรือการปรับปรุงเอกสาร โปรดสร้างกระทู้ในการสนทนา GitHub

การพัฒนา

มีคำแนะนำสั้นๆ สำหรับการตั้งค่าสภาพแวดล้อมการพัฒนา หากคุณต้องการมีส่วนร่วมในการเปลี่ยนแปลง แก้ไข และปรับปรุง Outline

มีส่วนร่วม

Outline สร้างและดูแลโดยทีมงานเล็กๆ เรายินดีเป็นอย่างยิ่งที่คุณจะช่วยแก้ไขข้อบกพร่องและเพิ่มฟีเจอร์ต่างๆ

ก่อนที่จะส่งคำขอดึง โปรด หารือกับทีมหลักโดยการสร้างหรือแสดงความคิดเห็นในประเด็นบน GitHub - เรายินดีรับฟังจากคุณในการสนทนาด้วย วิธีนี้ทำให้เรามั่นใจได้ว่ามีการตกลงแนวทางก่อนที่จะเขียนโค้ด ซึ่งจะส่งผลให้มีความเป็นไปได้สูงที่รหัสของคุณจะได้รับการยอมรับ

หากคุณกำลังมองหาวิธีเริ่มต้น ต่อไปนี้เป็นรายการวิธีที่จะช่วยเราปรับปรุง Outline:

• การแปลเป็นภาษาอื่น
• ปัญหาเกี่ยวกับฉลาก good first issue
• การปรับปรุงประสิทธิภาพทั้งบนเซิร์ฟเวอร์และส่วนหน้า
• ความสุขของนักพัฒนาและเอกสารประกอบ
• ข้อบกพร่องและปัญหาอื่นๆ ที่แสดงอยู่ใน GitHub

สถาปัตยกรรม

หากคุณสนใจที่จะมีส่วนร่วมหรือเรียนรู้เพิ่มเติมเกี่ยวกับโค้ดเบส Outline โปรดดูเอกสารสถาปัตยกรรมก่อนเพื่อดูภาพรวมระดับสูงเกี่ยวกับวิธีการรวมแอปพลิเคชันเข้าด้วยกัน

การดีบัก

ในการพัฒนา Outline จะส่งออกการบันทึกอย่างง่ายไปยังคอนโซล โดยนำหน้าตามหมวดหมู่ ในการใช้งานจริง ระบบจะส่งออกบันทึก JSON ซึ่งสามารถแยกวิเคราะห์ได้อย่างง่ายดายตามไปป์ไลน์การนำเข้าบันทึกที่คุณต้องการ

การบันทึก HTTP ถูกปิดใช้งานตามค่าเริ่มต้น แต่สามารถเปิดใช้งานได้โดยการตั้งค่าตัวแปรสภาพแวดล้อม DEBUG=http

การทดสอบ

เรามุ่งหวังที่จะมีความครอบคลุมการทดสอบเพียงพอสำหรับส่วนสำคัญของแอปพลิเคชัน และไม่ได้ตั้งเป้าที่จะครอบคลุมการทดสอบหน่วย 100% จุดสิ้นสุด API ทั้งหมดและการตรวจสอบความถูกต้องใดๆ ที่เกี่ยวข้องควรได้รับการทดสอบอย่างละเอียด

หากต้องการเพิ่มการทดสอบใหม่ ให้เขียนการทดสอบของคุณด้วย Jest และเพิ่มไฟล์ที่มีนามสกุล .test.js ถัดจากโค้ดที่ทดสอบ

 # To run all tests
make test

# To run backend tests in watch mode
make watch

เมื่อสร้างฐานข้อมูลทดสอบด้วย make test คุณสามารถรันการทดสอบส่วนหน้าและส่วนหลังแยกกันได้โดยตรง

 # To run backend tests
yarn test:server

# To run a specific backend test
yarn test:server myTestFile

# To run frontend tests
yarn test:app

การโยกย้าย

Sequelize ใช้เพื่อสร้างและเรียกใช้การย้ายข้อมูล เช่น

yarn sequelize migration:generate --name my-migration
yarn sequelize db:migrate

หรือเรียกใช้การย้ายข้อมูลบนฐานข้อมูลทดสอบ:

yarn sequelize db:migrate --env test

กิจกรรม

ใบอนุญาต

Outline ได้รับอนุญาตจาก BSL 1.1