sonar

sonar

Una base de datos P2P y un motor de búsqueda que se ejecuta en la parte superior de la pila DAT.

Este es el principal repositorio de Sonar. La configuración habitual es que ejecuta sonar-server en localhost y luego interactúa con el sonar a través del cliente, la interfaz de usuario que se ejecuta en http: // localhost: 9191 o el CLI. La CLI se puede invocar con ./sonar desde la raíz de este repositorio, y también se usa para iniciar el servidor.

El sitio web de Docs tiene más documentación (WIP).

Instalación

SONAR requiere Node.js versión 16 o superior. Si su sistema envía una versión anterior, puede usar una herramienta como NVM para instalar una versión actualizada. En el sistema basado en Debian, también puede probar las distribuciones Node.js de Nodesource.

Puede verificar su versión Node.js ejecutando node --version en una línea de comandos.

Posteriormente, instale sonar con el siguiente comando:

npm install -g @arsonar/server

Luego puede ejecutar la interfaz de línea de comandos sonar . Con esto, puede iniciar el servidor e interactuar con él desde la línea de comandos.

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

Desarrollo

Nota: En este momento se recomienda el hilo 1, instálelo de acuerdo con las instrucciones.

 # 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

Puede comenzar Sonar con ./sonar desde la raíz del repositorio.

Si el inicio falla con errores relacionados con sonar-tantivy , intente descargar o reconstruir Sonar-Tantivy (el motor de búsqueda incluido en Sonar):

 yarn run rebuild:tantivy

Si el inicio falla con errores relacionados con client , intente reconstruir el cliente:

 yarn run build:client

 # start the sonar server
./sonar start

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

Ejecutando los ejemplos

Este repositorio incluye algunos ejemplos. Para ejecutarlos localmente, haga lo siguiente:

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

Usando el CLI

Ejecutar ./sonar help para una lista de comandos compatibles.

Que contribuye

SONAR es un proyecto joven de código abierto y todo tipo de contribuciones son bienvenidas. Estamos en el proceso de escribir más documentación y vistas generales de cómo funcionan las cosas y se unen (en un libro).

En caso de duda, ¡habla con nosotros! Por ejemplo, en IRC en #DAT en Freenode (o en el navegador a través de Gitter. Más sobre este proyecto en Arso.xyz.

Diseño de repositorio

El repositorio está estructurado como un monorreo de diferentes paquetes (que son interdependientes en varios puntos).

• Core It the Core Module. Gestiona las colecciones , que son nuestra noción de "un grupo de feeds*. Cada colección tiene un Kappa-Record-DB que está conectado a un índice de búsqueda a través de Tantivy. Cada colección también tiene una lista de hiperlobs asociados para almacenar contenido de archivos sin procesar.

• Server proporciona una API HTTP de estilo REST que la CLI y la interfaz de usuario usan tanto para acceder y administrar los datos en paquetes/núcleo.

• El cliente es una biblioteca de clientes JavaScript. Es utilizado tanto por la CLI como por la interfaz de usuario. Habla con paquetes/servidor a través de HTTP.

• La UI es una aplicación de una sola página para navegar en los datos en SONAR.

• CLI es una aplicación de línea de comandos. Puede administrar colecciones, poner y ingresar a la base de datos, cargar y descargar archivos, y hacer consultas de búsqueda.

Apoyo

Este proyecto fue amablemente compatible con NLNET en el programa de búsqueda y descubrimiento de próxima generación.