これがソナーの主要なリポジトリです。通常のセットアップは、LocalHostでsonar-serverを実行し、クライアントを介してSonarと対話することです。UIはhttp:// localhost:9191またはCLIで実行されます。 CLIは、このリポジトリのルートから./sonarで呼び出すことができ、サーバーの起動にも使用されます。
Docs Webサイトには、より多くのドキュメント(WIP)があります。
Sonarにはnode.jsバージョン16以降が必要です。システムが古いバージョンを出荷する場合、NVMなどのツールを使用して最新のバージョンをインストールできます。 Debianベースのシステムでは、nodeSourceからnode.js分布を試すこともできます。
node.jsバージョンは、コマンドラインでnode --versionを実行して確認できます。
その後、次のコマンドでソナーをインストールします。
npm install -g @arsonar/serverその後、 sonarコマンドラインインターフェイスを実行できます。これにより、コマンドラインからサーバーを起動して対話することができます。
# show help
sonar help
# show help for specific commands
sonar help collection
# start a server
sonar start注:現時点では、YARN 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に関連するエラーで開始が失敗した場合は、Sonar-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サポートされているコマンドのリストのために./sonar helpを実行します。
ソナーは若いオープンソースプロジェクトであり、あらゆる種類の貢献を歓迎します。私たちは、物事がどのように機能し、一緒になっているかについてのより多くのドキュメントと概要を書く過程にあります(本で)。
疑わしい場合は、私たちに相談してください!たとえば、FreeNodeの#DatのIRC(またはGitterを介したブラウザで。このプロジェクトの詳細については、arso.xyz。
リポジトリは、さまざまなパッケージのモノレポとして構成されています(複数のポイントで相互依存しています)。
コアはコアモジュールです。コレクションを管理します。コレクションは、「フィードのグループ*」という概念です。各コレクションには、タンティビーを介して検索インデックスに接続されたkappa-record-dbがあります。各コレクションには、関連するハイパーブロブのリストもあります。
サーバーは、CLIとUIの両方が使用するRESTスタイルのHTTP APIを提供し、パッケージ/コアのデータにアクセスして管理します。
クライアントはJavaScriptクライアントライブラリです。 CLIとUIの両方で使用されています。 HTTPを介してパッケージ/サーバーに話しかけます。
UIは、ソナーのデータを閲覧するための単一ページのアプリケーションです。
CLIはコマンドラインアプリケーションです。コレクションを管理し、データベースに入力して入力し、ファイルをアップロードしてダウンロードし、検索クエリを作成できます。
このプロジェクトは、次世代の検索&ディスカバリープログラムでNLNETによって親切にサポートされました。