sonar Download - sonar Source Code Download

sonar

Anderer Quellcode

1.0.0

Herunterladen

Sonar

Eine P2P -Datenbank und eine Suchmaschine, die oben im DAT -Stapel ausgeführt wird.

Dies ist das Haupt -Sonar -Repository. Das übliche Setup ist, dass Sie sonar-server auf Localhost durchführen und dann mit Sonar über den Kunden interagieren, der Benutzeroberfläche, die auf http: // localhost: 9191 oder der CLI ausgeführt wird. Die CLI kann mit ./sonar vom Stamm dieses Repositorys aus aufgerufen werden und wird auch verwendet, um den Server zu starten.

Die DOCS -Website hat mehr Dokumentation (WIP).

Installation

Sonar benötigt Node.js Version 16 oder höher. Wenn Ihr System eine ältere Version liefert, können Sie ein Tool wie NVM verwenden, um eine aktuelle Version zu installieren. Auf Debian-basiertem System können Sie auch die Node.js-Verteilungen von Nodesource ausprobieren.

Sie können Ihre Node.js-Version überprüfen, indem Sie node --version auf einer Befehlszeile ausführen.

Installieren Sie den Sonar anschließend mit dem folgenden Befehl:

npm install -g @arsonar/server

Sie können dann die sonar Command-Line-Schnittstelle ausführen. Damit können Sie sowohl den Server starten als auch mit ihm aus der Befehlszeile interagieren.

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

Entwicklung

HINWEIS: Installieren Sie es im Moment Garn 1, bitte installieren Sie es gemäß den Anweisungen.

 # 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

Sie können Sonar mit ./sonar aus der Repository -Wurzel starten.

Wenn der Start mit Fehlern im Zusammenhang mit sonar-tantivy fehlschlägt, versuchen Sie, Sonar-Tantivy (die in Sonar enthaltene Suchmaschine enthalten) zu beladen oder wieder aufzubauen:

 yarn run rebuild:tantivy

Wenn der Start bei Fehlern im Zusammenhang mit client fehlschlägt, versuchen Sie, den Kunden wieder aufzubauen:

 yarn run build:client

 # start the sonar server
./sonar start

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

Ausführen der Beispiele

Dieses Repo enthält einige Beispiele. Um sie lokal zu führen, machen Sie Folgendes:

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

Mit der CLI

Run ./sonar help für eine Liste unterstützter Befehle.

Beitragen

Sonar ist ein junges Open -Source -Projekt und alle Arten von Beiträgen sind willkommen. Wir sind gerade dabei, mehr Dokumentation und Übersichten darüber zu schreiben, wie Dinge funktionieren und zusammenkommen (in einem Buch).

Im Zweifelsfall sprechen Sie mit uns! Zum Beispiel auf IRC in #dat auf Freenode (oder im Browser über Gitter. Mehr zu diesem Projekt auf arso.xyz.

Repo -Layout

Das Repo ist als Monorepo verschiedener Pakete strukturiert (die an mehreren Stellen voneinander abhängig sind).

Kern es das Kernmodul. Es verwaltet Kollektionen , die unsere Vorstellung von "einer Gruppe von Feeds*" sind. Jede Sammlung verfügt über eine Kappa-Rekord-DB, die über Tantivy in einen Suchindex angeschlossen ist. Jede Sammlung hat auch eine Liste zugehöriger Hyperblobs, um Rohdateiinhalte zu speichern.
Der Server bietet eine HTTP -API im Ruhezustand, die sowohl von der CLI als auch von der Benutzeroberfläche verwendet wird, um auf die Daten in Paketen/Kern zuzugreifen und zu verwalten.
Der Client ist eine JavaScript -Client -Bibliothek. Es wird sowohl von der CLI als auch von der Benutzeroberfläche verwendet. Es spricht mit Paketen/Server über HTTP.
UI ist eine einseitige Anwendung, um Daten in Sonar zu durchsuchen.
CLI ist eine Befehlszeilenanwendung. Es kann Sammlungen verwalten, die Datenbank einfügen und in die Datenbank einsteigen, Dateien hochladen und herunterladen und Suchanfragen erstellen.