Как внести вклад в Perplexica

Спасибо за ваш интерес к внесению вклада в Perplexica! Ваша помощь делает этот проект лучше. Этот гайд объясняет, как эффективно вносить вклад.

Perplexica — это современное приложение для чата с искусственным интеллектом, обладающее продвинутыми возможностями поиска.

Структура проекта

Кодовая база Perplexica организована следующим образом:- UI Компоненты и Страницы:

• Компоненты (src/components): Пересоздаваемые UI компоненты.
• Страницы и маршруты (src/app): Структура директорий Next.js с компонентами страниц.
  • Основные маршруты приложения включают: главная страница (/), чат (/c), открытие (/discover), библиотека (/library), и настройки (/settings).
• API маршруты (src/app/api): API конечные точки, реализованные с помощью Next.js API маршрутов.
  • /api/chat: Обрабатывает взаимодействия с чатом.
  • /api/search: Предоставляет прямой доступ к продвинутым возможностям поиска Perplexica.
  • Другие конечные точки для моделей, файлов и предложений.
• Логика серверной части (src/lib): Содержит всю серверную функциональность, включая поиск, базу данных и логику API.
  • Функциональность поиска находится в директории src/lib/search.
• Все режимы фокуса реализованы с использованием класса Meta Search Agent в файле src/lib/search/metaSearchAgent.ts.
• Функциональность базы данных находится в директории src/lib/db.
• Поставщики моделей чата и вложения находятся в директории src/lib/providers.
• Шаблоны подсказок и определения цепочек LLM находятся в директориях src/lib/prompts и src/lib/chains соответственно.## Документация API

Perplexica предоставляет несколько API конечных точек для программного доступа, включая:

• API поиска: Получите прямой доступ к продвинутым возможностям поиска Perplexica через конечную точку /api/search. Для подробной документации см. docs/api/search.md.

Настройка вашей среды

Перед тем как приступить к программированию, настройка вашей локальной среды является ключевой. Вот что вам нужно сделать:

1. В корневой директории найдите файл sample.config.toml.
2. Переименуйте его в config.toml и заполните необходимые поля конфигурации.
3. Выполните npm install, чтобы установить все зависимости.
4. Выполните npm run db:push, чтобы настроить локальную базу данных SQLite.
5. Используйте npm run dev, чтобы запустить приложение в режиме разработки.

Обратите внимание: Конфигурации Docker присутствуют для настройки среды производства, в то время как npm run dev используется для разработки.

Практики кодирования и внесения вклада

Перед выполнением коммитов:

1. Убедитесь, что ваш код работает корректно путем тщательного тестирования.
2. Всегда запускайте npm run format:write, чтобы форматировать ваш код в соответствии с кодовыми стандартами проекта. Это помогает поддерживать последовательность и качество кода.
3. В настоящее время у нас нет кода поведения, но работа над ним ведется. Временно, пожалуйста, будьте внимательны к тому, как вы взаимодействуете с проектом и его сообществом.Следование этим шагам поможет поддерживать целостность базы кода Perplexica и облегчит интеграцию вашего ценных вкладов. Спасибо за вашу поддержку и приверженность улучшению Perplexica.