sonar

сонар

База данных P2P и поисковая система, работающая поверх стека DAT.

Это основной репозиторий сонара. Обычная настройка заключается в том, что вы управляете sonar-server на Localhost, а затем взаимодействуете с Sonar через клиента, пользовательский интерфейс, работающий на http: // localhost: 9191 или CLI. CLI может быть вызван ./sonar из корня этого репозитория, а также используется для запуска сервера.

На сайте DOCS есть больше документации (WIP).

Установка

Sonar требует node.js версии 16 или выше. Если ваша система отправляет более старую версию, вы можете использовать такой инструмент, как NVM для установки современной версии. В системе на основе Debian вы также можете попробовать распределения node.js от Nodesource.

Вы можете проверить свою версию node.js, запустив node --version в командной строке.

После этого установите Sonar со следующей командой:

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 из корня репозитория.

Если старт терпит неудачу с ошибками, связанными с sonar-tantivy , попробуйте REDOWNLOAD или восстановить 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

Используя CLI

Запустите ./sonar help для списка поддерживаемых команд.

Внося

Sonar - это молодой проект с открытым исходным кодом, и всевозможные вклады приветствуются. Мы находимся в процессе написания большей документации и обзоров того, как все работает и собирается вместе (в книге).

Если вы сомнетесь, поговорите с нами! Например, на IRC в #DAT на Freenode (или в браузере через Gitter. Подробнее об этом проекте на Arso.xyz.

Репо

Репо структурировано как монорепо разных пакетов (которые взаимозависимы в нескольких точках).

• Core It Core Module. Он управляет коллекциями , которые являются нашим представлением о «группе каналов*. Каждая коллекция имеет каппа-рекорд-DB, который подключен к индексу поиска через Tantivy. Каждая коллекция также имеет список связанных гиперблобов для хранения содержимого необработанного файла.

• Server предоставляет HTTP API в стиле REST, который используется как CLI, так и пользовательского интерфейса для доступа и управления данными в пакетах/ядре.

• Клиент - это клиентская библиотека JavaScript. Он используется как CLI, так и пользовательским интерфейсом. Он говорит с пакетами/сервером по HTTP.

• Пользовательский интерфейс -это одностраничное приложение для просмотра данных в Sonar.

• CLI -это приложение командной строки. Он может управлять коллекциями, поместить и попасть в базу данных, загружать и загружать файлы и задавать поисковые запросы.

Поддерживать

Этот проект был любезно поддержан NLNet в программе поиска и обнаружения следующего поколения.