sonar

sonar

Um banco de dados P2P e um mecanismo de pesquisa em execução na parte superior da pilha DAT.

Este é o principal repositório do sonar. A configuração usual é que você executa sonar-server no host local e, em seguida, interage com o Sonar através do cliente, a interface do usuário em execução no http: // localhost: 9191 ou a CLI. A CLI pode ser invocada com ./sonar da raiz deste repositório e também é usada para iniciar o servidor.

O site do DOCS possui mais documentação (WIP).

Instalação

O sonar requer Node.js versão 16 ou superior. Se o seu sistema enviar uma versão mais antiga, você poderá usar uma ferramenta como o NVM para instalar uma versão atualizada. No sistema baseado em Debian, você também pode experimentar as distribuições Node.js do Sodesource.

Você pode verificar sua versão Node.js executando node --version em uma linha de comando.

Depois, instale o sonar com o seguinte comando:

npm install -g @arsonar/server

Você pode executar a interface da linha de comando sonar . Com isso, você pode iniciar o servidor e interagir com ele na linha de comando.

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

Desenvolvimento

NOTA: No momento, o YARN 1 é recomendado, instale -o de acordo com as instruções.

 # 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

Você pode iniciar o sonar com ./sonar da raiz do repositório.

Se o início falhar com erros relacionados ao sonar-tantivy , tente reduzir ou reconstruir o sonar-Tantivy (o mecanismo de pesquisa incluído no sonar):

 yarn run rebuild:tantivy

Se o início falhar com erros relacionados ao client , tente reconstruir o cliente:

 yarn run build:client

 # start the sonar server
./sonar start

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

Executando os exemplos

Este repositório inclui alguns exemplos. Para executá -los localmente, faça o seguinte:

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

Usando a CLI

Execute ./sonar help para uma lista de comandos suportados.

Contribuindo

O Sonar é um projeto jovem de código aberto e todos os tipos de contribuições são bem -vindos. Estamos escrevendo mais documentação e visão geral de como as coisas funcionam e se reúnem (em um livro).

Em caso de dúvida, fale conosco! Por exemplo, no IRC no #dat no freeenode (ou no navegador através do Gitter. Mais sobre este projeto no arso.xyz.

Layout repo

O repositório é estruturado como um monorepo de diferentes pacotes (que são interdependentes em vários pontos).

• Core It o módulo principal. Ele gerencia coleções , que são a nossa noção de "um grupo de feeds*. Cada coleção possui um Kappa-Record-DB que está conectado a um índice de pesquisa através do Tantivy. Cada coleção também possui uma lista de hiperblobs associados para armazenar conteúdo de arquivo bruto.

• O servidor fornece uma API HTTP de estilo REST, usada pela CLI e pela interface do usuário para acessar e gerenciar os dados em pacotes/núcleo.

• O cliente é uma biblioteca de clientes JavaScript. É usado pela CLI e pela interface do usuário. Ele fala com pacotes/servidor sobre HTTP.

• A interface do usuário é um aplicativo de uma página para procurar dados no sonar.

• CLI é um aplicativo de linha de comando. Ele pode gerenciar coleções, colocar e entrar no banco de dados, fazer upload e baixar arquivos e fazer consultas de pesquisa.

Apoiar

Este projeto foi gentilmente apoiado pela NLNET no programa de pesquisa e descoberta da próxima geração.