sonar

sonar

Database P2P dan mesin pencari berjalan di atas tumpukan DAT.

Ini adalah gudang utama sonar. Pengaturan yang biasa adalah Anda menjalankan sonar-server di localhost dan kemudian berinteraksi dengan sonar melalui klien, UI berjalan di http: // localhost: 9191 atau cli. CLI dapat dipanggil dengan ./sonar dari akar repositori ini, dan juga digunakan untuk memulai server.

Situs web Docs memiliki lebih banyak dokumentasi (WIP).

Instalasi

Sonar membutuhkan Node.js versi 16 atau lebih tinggi. Jika sistem Anda mengirimkan versi yang lebih lama, Anda dapat menggunakan alat seperti NVM untuk menginstal versi terkini. Pada sistem berbasis Debian, Anda juga dapat mencoba distribusi Node.js dari NodeSource.

Anda dapat memeriksa versi node.js Anda dengan menjalankan node --version pada baris perintah.

Setelah itu, instal sonar dengan perintah berikut:

npm install -g @arsonar/server

Anda kemudian dapat menjalankan antarmuka baris perintah sonar . Dengan ini, Anda berdua dapat memulai server dan berinteraksi dengannya dari baris perintah.

 # show help
sonar help
# show help for specific commands
sonar help collection
# start a server
sonar start

Perkembangan

Catatan: Saat ini benang 1 disarankan, silakan instal sesuai dengan instruksi.

 # 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

Anda dapat memulai sonar dengan ./sonar dari root repositori.

Jika start gagal dengan kesalahan yang terkait dengan sonar-tantivy , cobalah untuk mereduksi ulang atau membangun kembali sonar-tantivy (mesin pencari yang termasuk dalam sonar):

 yarn run rebuild:tantivy

Jika awal gagal dengan kesalahan yang terkait dengan client , cobalah untuk membangun kembali klien:

 yarn run build:client

 # start the sonar server
./sonar start

# start the sonar server in dev mode
./sonar start --dev

Menjalankan contoh

Repo ini mencakup beberapa contoh. Untuk menjalankannya secara lokal, lakukan hal berikut:

 # build the typecript modules
yarn build
# start sonar
./sonar start --disable-authentication --dev
# run the example from the examples/ folder
yarn example react

Menggunakan CLI

Jalankan ./sonar help untuk daftar perintah yang didukung.

Berkontribusi

Sonar adalah proyek open source muda dan semua jenis kontribusi dipersilakan. Kami sedang dalam proses menulis lebih banyak dokumentasi dan ikhtisar tentang bagaimana hal -hal bekerja dan bersatu (dalam sebuah buku).

Jika ragu, bicaralah dengan kami! Misalnya pada IRC di #dat di freenode (atau di browser melalui gitter. Lebih lanjut tentang proyek ini di arso.xyz.

Tata letak repo

Repo disusun sebagai monorepo dari berbagai paket (yang saling bergantung pada beberapa titik).

• inti itu modul inti. Ini mengelola koleksi , yang merupakan gagasan kami tentang "sekelompok umpan*. Setiap koleksi memiliki kappa-rekaman-DB yang dicolokkan ke dalam indeks pencarian melalui TANTIVY. Setiap koleksi juga memiliki daftar hyperblob terkait untuk menyimpan konten file mentah.

• Server menyediakan API HTTP gaya istirahat yang digunakan baik oleh CLI dan UI untuk mengakses dan mengelola data dalam paket/inti.

• Klien adalah Perpustakaan Klien JavaScript. Ini digunakan oleh CLI dan UI. Ini berbicara kepada paket/server melalui HTTP.

• UI adalah aplikasi satu halaman untuk menelusuri data di Sonar.

• CLI adalah aplikasi baris perintah. Itu dapat mengelola koleksi, memasukkan dan masuk ke dalam database, mengunggah dan mengunduh file, dan membuat permintaan pencarian.

Mendukung

Proyek ini didukung oleh NLNET dalam program pencarian & penemuan generasi berikutnya.