sonar

sonar

Une base de données P2P et un moteur de recherche fonctionnant en haut de la pile DAT.

Ceci est le principal référentiel de sonar. La configuration habituelle est que vous exécutez sonar-server sur localhost, puis interagissez avec Sonar via le client, l'interface utilisateur exécutant sur http: // localhost: 9191 ou la CLI. La CLI peut être invoquée avec ./sonar à partir de la racine de ce référentiel et est également utilisée pour démarrer le serveur.

Le site Web DOCS a plus de documentation (WIP).

Installation

Sonar nécessite Node.js version 16 ou supérieure. Si votre système expédie une version plus ancienne, vous pouvez utiliser un outil comme NVM pour installer une version à jour. Sur le système basé à Debian, vous pouvez également essayer les distributions Node.js à partir de NODESORCE.

Vous pouvez vérifier votre version Node.js en exécutant node --version sur une ligne de commande.

Ensuite, installez le sonar avec la commande suivante:

npm install -g @arsonar/server

Vous pouvez ensuite exécuter l'interface de ligne de commande sonar . Avec cela, vous pouvez tous deux démarrer le serveur et interagir avec lui à partir de la ligne de commande.

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

Développement

Remarque: Pour le moment, le fil 1 est recommandé, veuillez l'installer en fonction des instructions.

 # 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

Vous pouvez commencer sonar avec ./sonar à partir de la racine du référentiel.

Si le début échoue avec des erreurs liées à sonar-tantivy , essayez de télécharger ou de reconstruire le sonar-surtant (le moteur de recherche inclus dans le sonar):

 yarn run rebuild:tantivy

Si le début échoue avec les erreurs liées au client , essayez de reconstruire le client:

 yarn run build:client

 # start the sonar server
./sonar start

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

Exécuter les exemples

Ce dépôt comprend quelques exemples. Pour les exécuter localement, procédez comme suit:

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

Utilisation de la CLI

Exécutez ./sonar help pour une liste des commandes prises en charge.

Contributif

Sonar est un jeune projet open source et toutes sortes de contributions sont les bienvenues. Nous sommes en train d'écrire plus de documentation et de vue d'ensemble de la façon dont les choses fonctionnent et se réunissent (dans un livre).

En cas de doute, parlez-nous! Par exemple sur IRC dans #DAT sur Freenode (ou dans le navigateur via Gitter. Plus sur ce projet sur ARSO.xyz.

Disposition de réapprovisionnement

Le repo est structuré comme un monorepo de différents packages (qui sont interdépendants en plusieurs points).

• Core It le module de base. Il gère les collections , qui sont notre notion de "un groupe de flux *. Chaque collection a un Kappa-Record-DB branché sur un index de recherche via Tantivy. Chaque collection a également une liste d'hyperblobs associés pour stocker le contenu des fichiers bruts.

• Le serveur fournit une API HTTP de style de repos qui est utilisée à la fois par la CLI et l'interface utilisateur pour accéder et gérer les données dans Packages / Core.

• Le client est une bibliothèque client JavaScript. Il est utilisé à la fois par la CLI et l'interface utilisateur. Il parle de packages / serveur via HTTP.

• L'interface utilisateur est une application à une seule page pour parcourir les données dans sonar.

• CLI est une application de ligne de commande. Il peut gérer les collections, mettre et entrer dans la base de données, télécharger et télécharger des fichiers et faire des requêtes de recherche.

Soutien

Ce projet a été aimablement pris en charge par NLNET dans le programme Search & Discovery Next Generation.