นี่คือที่เก็บหลักของโซนาร์ การตั้งค่าปกติคือคุณเรียกใช้ sonar-server บน LocalHost แล้วโต้ตอบกับ Sonar ผ่านลูกค้า UI ที่ทำงานบน http: // localhost: 9191 หรือ CLI CLI สามารถเรียกใช้กับ ./sonar จากรูทของที่เก็บนี้และยังใช้ในการเริ่มต้นเซิร์ฟเวอร์
เว็บไซต์ DOCS มีเอกสารเพิ่มเติม (WIP)
Sonar ต้องการ node.js เวอร์ชัน 16 หรือสูงกว่า หากระบบของคุณจัดส่งรุ่นเก่าคุณสามารถใช้เครื่องมือเช่น NVM เพื่อติดตั้งเวอร์ชันล่าสุด ในระบบที่ใช้ Debian คุณสามารถลองการแจกแจง Node.js จาก NodeSource
คุณสามารถตรวจสอบเวอร์ชัน node.js ของคุณได้โดยเรียกใช้ node --version บนบรรทัดคำสั่ง
หลังจากนั้นติดตั้งโซนาร์ด้วยคำสั่งต่อไปนี้:
npm install -g @arsonar/server จากนั้นคุณสามารถเรียกใช้อินเทอร์เฟซบรรทัดคำสั่ง sonar ด้วยสิ่งนี้คุณสามารถเริ่มต้นเซิร์ฟเวอร์และโต้ตอบกับมันจากบรรทัดคำสั่ง
# show help
sonar help
# show help for specific commands
sonar help collection
# start a server
sonar startหมายเหตุ: แนะนำให้ใช้เส้นด้าย 1 โปรดติดตั้งตามคำแนะนำ
# clone the sonar repository
git clone https://github.com/arso-project/sonar.git
cd sonar
# install dependencies of all workspaces
yarn
# build the typescript modules and bundle the UI
yarn run build คุณสามารถเริ่มต้นโซนาร์ด้วย ./sonar sonar จากรูทที่เก็บ
หากการเริ่มต้นล้มเหลวด้วยข้อผิดพลาดที่เกี่ยวข้องกับ sonar-tantivy ลอง redownload หรือสร้าง Sonar-Tantivy (เครื่องมือค้นหาที่รวมอยู่ใน Sonar):
yarn run rebuild:tantivy
หากการเริ่มต้นล้มเหลวด้วยข้อผิดพลาดที่เกี่ยวข้องกับ client ลองสร้างไคลเอนต์ใหม่:
yarn run build:client
# start the sonar server
./sonar start
# start the sonar server in dev mode
./sonar start --dev
repo นี้รวมถึงตัวอย่างบางส่วน หากต้องการเรียกใช้ในพื้นที่ให้ทำสิ่งต่อไปนี้:
# build the typecript modules
yarn build
# start sonar
./sonar start --disable-authentication --dev
# run the example from the examples/ folder
yarn example react Run ./sonar help สำหรับรายการคำสั่งที่รองรับ
Sonar เป็นโครงการโอเพนซอร์สรุ่นเยาว์และยินดีต้อนรับทุกประเภท เราอยู่ในขั้นตอนการเขียนเอกสารเพิ่มเติมและภาพรวมของวิธีการทำงานและมารวมกัน (ในหนังสือ)
ถ้ามีข้อสงสัยคุยกับเรา! ตัวอย่างเช่นเกี่ยวกับ IRC ใน #DAT บน freenode (หรือในเบราว์เซอร์ผ่าน Gitter เพิ่มเติมในโครงการนี้ใน arso.xyz
repo มีโครงสร้างเป็น monorepo ของแพ็คเกจที่แตกต่างกัน (ซึ่งพึ่งพาซึ่งกันและกันที่หลายจุด)
หลัก มันเป็นโมดูลหลัก มันจัดการ คอลเลกชัน ซึ่งเป็นความคิดของเราเกี่ยวกับ "กลุ่มของฟีด*แต่ละคอลเลกชันมีคัปปารีคอร์ด -DB ที่เสียบเข้ากับดัชนีการค้นหาผ่าน tantivy แต่ละคอลเลกชันมีรายการ hyperblobs ที่เกี่ยวข้องเพื่อเก็บเนื้อหาไฟล์ดิบ
เซิร์ฟเวอร์ จัดเตรียม HTTP API สไตล์ที่เหลือซึ่งใช้ทั้ง CLI และ UI เพื่อเข้าถึงและจัดการข้อมูลในแพ็คเกจ/คอร์
ไคลเอนต์ เป็นไลบรารีไคลเอนต์ JavaScript มันถูกใช้โดยทั้ง CLI และ UI มันพูดถึงแพ็คเกจ/เซิร์ฟเวอร์ผ่าน HTTP
UI เป็นแอปพลิเคชันหน้าเดียวเพื่อเรียกดูข้อมูลใน Sonar
CLI เป็นแอปพลิเคชันบรรทัดคำสั่ง มันสามารถจัดการคอลเลกชันใส่และเข้าไปในฐานข้อมูลอัปโหลดและดาวน์โหลดไฟล์และทำการค้นหา
โครงการนี้ได้รับการสนับสนุนจาก NLNET ในโปรแกรมการค้นหาและค้นหารุ่นต่อไป