octopus Download - ดาวน์โหลดซอร์สโค้ด octopus

octopus

ซอร์สโค้ดอื่น ๆ

1.0.0

ดาวน์โหลด

ปลาหมึกยักษ์

Octopus เป็นหน้า Wiki ภายในที่ง่ายต่อการตั้งค่าเซิร์ฟเวอร์ที่ง่ายต่อการตั้งค่าพร้อมการรองรับไดอะแกรมซอฟต์แวร์ในตัว มันใช้ markdown สำหรับการเขียนเนื้อหาและปรับปรุงด้วย graphviz และ flowchart.js ไดอะแกรมสำหรับเอกสารซอฟต์แวร์ที่ง่าย

นี่คือหน้าวิกิเริ่มต้น:

เทคโนโลยี

Octopus เป็นแอพ Jamstack ที่ใช้ Google Firebase เป็นแบ็กเอนด์ คุณไม่จำเป็นต้องมีเว็บเซิร์ฟเวอร์ (เช่น Apache) หรือฐานข้อมูล (เช่น MySQL) เพื่อให้มันทำงานได้ คุณสามารถปรับใช้แอพไปยัง CDN ได้ฟรีโดยใช้ NetLify

ด้วย Octopus คุณสามารถ:

กำหนดให้ผู้ใช้ต้องลงชื่อเข้าใช้เพื่ออ่านหรือแก้ไขวิกิ (ผู้ให้บริการที่รองรับ: Google, GitHub, อีเมล/รหัสผ่าน, Twitter และโทรศัพท์)
สร้างกฎการเข้าถึงสำหรับการอ่านและแก้ไข (จำกัด ผู้ใช้เฉพาะหรือโดเมนตรวจสอบ)
หน้าโฮสต์วิกิภายใต้โดเมนที่กำหนดเอง

คุณสมบัติ

สร้างหน้าวิกิใหม่ด้วยภาษา Markdown
แก้ไขเมนู (ใช้ markdown) เพื่อเชื่อมโยงไปยังหน้า wiki ได้อย่างง่ายดาย
รวมไดอะแกรม graphviz และ flowchart.js ภายในเนื้อหา Markdown ของคุณ
ดูว่าใครกำลังอ่านบทความ Wiki ของคุณอยู่
ปรับ Wiki Front-end ของคุณด้วย React (Create-React-App)

ตัวอย่างไดอะแกรมระบบ

การแก้ไขหน้าด้วย markdown

การติดตั้ง

โคลนที่เก็บนี้ไปยังคอมพิวเตอร์ของคุณ
คัดลอกไฟล์เทมเพลต config ( src/config/config.template.js ) ไปยัง src/config/config.js

cp src/config/config.template.js src/config/config.js

หมายเหตุ: คุณสามารถส่งไฟล์ src/config/config.js ไปยังที่เก็บได้อย่างปลอดภัย ไฟล์นี้ไม่ได้จัดเก็บข้อมูลรับรองที่ละเอียดอ่อน - ตัวแปรการกำหนดค่าทั้งหมดจะเปิดเผยต่อสาธารณะในไฟล์ .js ต่อไป

สร้างโครงการ Firebase ใหม่ที่นี่: https://firebase.google.com/
เลือก "เพิ่ม firebase ไปยังเว็บแอปของคุณ" และคัดลอก config ไปยัง src/config/config.js ที่สร้างขึ้นในขั้นตอนที่ 2

ในคอนโซล Firebase ให้ไปที่ การตรวจสอบความถูกต้อง > วิธีการลงชื่อเข้าใช้ เลือกผู้ให้บริการและเปิดใช้งาน Octopus ได้รับการทดสอบกับผู้ให้บริการของ Google และ GitHub

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

สร้างแอพ:

npm install
npm run build

ปรับใช้ build/ Directory ไปยังเว็บเซิร์ฟเวอร์ของคุณ

การปรับใช้เซิร์ฟเวอร์น้อย

คุณสามารถข้ามการโฮสต์แอพบนเว็บเซิร์ฟเวอร์ของคุณ (ขั้นตอนที่ 8 จากคู่มือการติดตั้งด้านบน) สิ่งที่คุณต้องมีคือการปรับใช้แอพให้กับผู้ให้บริการ CDN บนคลาวด์

เราขอแนะนำให้ใช้ NetLify

มันจะปรับใช้ Octopus GitHub Repo ของคุณโดยอัตโนมัติเพื่อผลิตหลังจากการกระทำแต่ละครั้ง นอกจากนี้ยังจะเตรียม URL พร้อมใช้งานที่ผู้ใช้ทั้งหมดของคุณสามารถเข้าถึงได้ทันที ในภายหลังคุณสามารถตั้งค่าโดเมนที่กำหนดเองเพื่อให้ดูเป็นมืออาชีพมากขึ้น

หมายเหตุ: เมื่อปรับใช้ octopus ผ่าน netlify ให้กรอกรายละเอียดต่อไปนี้ในตัวช่วยสร้างการตั้งค่า:

สร้างคำสั่ง: npm run build
เผยแพร่ไดเรกทอรี: build

ความปลอดภัย

โดยค่าเริ่มต้นผู้ใช้ใด ๆ สามารถดูและแก้ไขหน้า wiki ของคุณ อาจจะไม่ใช่สิ่งที่คุณคาดหวัง!

เพื่อให้เนื้อหาของคุณสามารถเข้าถึงได้เฉพาะกับ บริษัท ของคุณให้ไปที่ คอนโซล Firebase > ฐานข้อมูล > กฎ และ จำกัด ผู้ที่สามารถอ่านและแก้ไขหน้า Wiki ของคุณได้

นี่คือกฎตัวอย่างหากคุณใช้ผู้ให้บริการลงชื่อเข้าใช้ Google และที่อยู่อีเมลของ บริษัท ของคุณลงท้ายด้วย @LiveChatinc.com :

{
  "rules": {
    ".read": "auth.token.email.endsWith('@livechatinc.com')",
    ".write": "auth.token.email.endsWith('@livechatinc.com')"
  }
}

คุณสามารถอ่านเพิ่มเติมเกี่ยวกับกฎความปลอดภัยที่เป็นไปได้ในเอกสารกฎฐานข้อมูลเรียลไทม์

ใช้ปลาหมึกยักษ์

Octopus ได้รับการออกแบบให้ใช้งานง่ายมาก

ในการสร้างหน้าใหม่เพียงป้อน URL ที่คุณต้องการสร้างตัวอย่างเช่น https://<your-octopus-domain>/test/new-page หากยังไม่ได้สร้างหน้าดังกล่าวคุณจะเห็นหน้าจอต่อไปนี้:

เมื่อคุณคลิก "สร้างหน้านี้" หน้าใหม่จะถูกสร้างและกรอกด้วยเนื้อหาเริ่มต้นพร้อมที่จะแก้ไข:

เมื่อหน้าพร้อมแล้วคุณสามารถรวมไว้ในเมนูได้อย่างง่ายดาย:

แค่นั้นแค่นั้น ส่งลิงค์เพื่อนร่วมทีมทั้งหมดของคุณไปยัง Octopus และพวกเขาพร้อมที่จะมีส่วนร่วม!

พื้นหลังโครงการ

ทำไมเราถึงสร้างปลาหมึกยักษ์?

เราได้ดิ้นรนกับการค้นหาซอฟต์แวร์ที่ใช้งานง่ายสำหรับการจัดทำเอกสารระบบภายในที่ LiveChat

เราต้องการให้มันเป็นเรื่องง่ายที่จะมีส่วนร่วมสำหรับ คนที่ไม่ใช่ด้านเทคนิค และรวมถึง ไดอะแกรมซอฟต์แวร์ที่แก้ไขได้ ง่าย เราไม่พบผลิตภัณฑ์ที่น่าพอใจดังนั้นเราจึงสร้างผลิตภัณฑ์