sonar

声纳

P2P数据库和搜索引擎在DAT堆栈顶部运行。

这是声纳的主要存储库。通常的设置是您在Localhost上运行sonar-server ，然后通过客户端与Sonar进行交互，UI在http：// localhost上运行：9191或CLI。可以从此存储库的根中调用CLI，并与./sonar一起使用，也可用于启动服务器。

文档网站有更多文档（WIP）。

安装

Sonar需要Node.js版本16或更高版本。如果您的系统寄出了较旧版本，则可以使用NVM之类的工具来安装最新版本。在基于Debian的系统上，您还可以尝试来自Nodesource的Node.js发行版。

您可以通过在命令行上运行node --version来检查node.js版本。

之后，使用以下命令安装声纳：

npm install -g @arsonar/server

然后，您可以运行sonar命令行界面。这样，您既可以启动服务器并从命令行进行交互。

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

发展

注意：目前建议使用纱线1，请根据说明将其安装。

 # 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

您可以从存储库根开始使用./sonar 。

如果开始因与sonar-tantivy相关的错误而失败，请尝试重新载荷或重建声纳 - tantivy（Sonar中包含的搜索引擎）：

 yarn run rebuild:tantivy

如果开始因与client相关的错误而失败，请尝试重建客户端：

 yarn run build:client

 # start the sonar server
./sonar start

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

运行示例

此存储库包括一些示例。要在本地运行它们，请执行以下操作：

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

使用CLI

运行./sonar help ，以获取支持命令的列表。

贡献

Sonar是一个年轻的开源项目，欢迎各种贡献。我们正在编写更多的文档和有关事物的工作方式和聚在一起的概述（在书中）。

如有疑问，请与我们交谈！例如，在FreeNode上的#DAT中的IRC上（或通过Gitter在浏览器中。有关此项目的更多信息。

回购布局

存储库的结构是不同包装的单向波（在几个点相互依存）。

• 将其核心为核心模块。它管理集合，这是我们的“一组feed*。每个集合都有一个Kappa record-DB，它通过Tantivy插入了搜索索引中。每个集合都有一个关联的超企业列表来存储原始文件内容。

• 服务器提供了REST样式的HTTP API，该API均由CLI和UI使用，以访问和管理包装/核心的数据。

• 客户端是JavaScript客户库库。 CLI和UI都使用它。它可以通过HTTP与软件包/服务器说话。

• UI是单页的应用程序，可在声纳中浏览数据。

• CLI是命令行应用程序。它可以管理集合，放入并进入数据库，上传和下载文件，并进行搜索查询。

支持

NLNet在下一代搜索和发现程序中得到了该项目的支持。