itchgrep

itchgrep.com

Откройте для себя идеальные активы для ваших игр

? Поиск через активы itch.io с использованием текстовых запросов; Найдите то, что вам нужно, не полагаясь исключительно на теги.

Посетите itchgrep.com, чтобы начать исследовать.

? Присоединяйтесь к нашему сообществу

У нас есть? Discord Server! Это место для обмена, обучения и разговоров о разработке игр и проектах, которые мы увлечены. Не стесняйтесь присоединиться к нам!

? Поддержите Itchgrep

Ваша поддержка подпитывает нашу страсть и помогает поддерживать работу серверов! Если вы цените то, что мы делаем, и хотите внести свой вклад в наше путешествие, подумайте:

• ? Купите мне кофе! Ваша щедрость очень ценится, и каждая чашка позволяет мне продолжать работать над прохладными вещами.

? TechStack

• Идти
• Храм
• Пролечить
• HTMX
• Google Cloud
• Докер

Эти инструменты и технологии были выбраны с осторожностью для обеспечения бесшовного и эффективного опыта как для разработчиков, так и для пользователей ITCHGREP.

? Архитектура

Бег на местном уровне

Если вы хотите внести свой вклад или просто запустить проект локально для собственного использования, следуйте инструкциям ниже.

Этот проект построен и поддерживается на Linux. Хотя я не думаю, что в Windows обычно невозможно запускать, но файл задачи записывается с использованием команд Linux.

Зависимости от инструментов

• Голанг
• Задача
• Докер
• Gcloud

Бег

Проект разделен на две услуги:

• dataservice , ответственный за получение списка активов из itch.io
• webserver , представляющий сохраненные данные с инструментами поиска.

Используйте включенные задачи, чтобы запустить эти услуги.

• task local-dataservice запустит dataservice с локальным экземпляром GCS. Отправьте запрос GET в конечную точку триггера: curl -X GET "localhost:8080/trigger-fetch" . Это приведет к тому, что служба сосказывает данные из itch.io, индексирует их и сохранит как данные, так и индекс на локальном GCS.

• !! Способ работы, описанный выше, в настоящее время не работает должным образом, я ищу помощь в этом. См. Выпуск № 1. Тем временем используйте task local-dataservice-temp-fix . Это запускает dataservice без Docker.
• task local-webserver будет создавать и запустить веб-сервер в контейнере Docker вместе с локальными GCS в отдельном контейнере. Шаблоны Templ не копируются во время сборки, но генерируются внутри контейнера.
• task templ будет генерировать файлы .go из любых файлов .templ . Это не требуется для создания/запуска, а для предоставления завершения кода и предотвращения жалоб на языковой сервер.

Развертывание в облаке

Проект был создан с целью размещения как dataservice , так и webserver в Google Cloud Run. Данные активов предназначены для хранения в Google Cloud Store.

Google Cloud Run может быть заменен любой платформой без серверов, и Google Cloud Store может быть заменен любым магазином объектов, но для этого потребуется некоторые работы, если это ваша цель, и следующие инструкции будут принимать Google Cloud Services.

Чтобы развернуть проект в Google Cloud, выполните приведенные ниже шаги.

Настройка gcloud

Пара шагов подготовки:

• Убедитесь, что вы настроили проект в вашей облачной консоли Google.
• В вашем проекте создайте магазин объектов с именем itchgrep-data . (Вы также можете использовать другое имя здесь, но затем вы должны изменить const в файле internal/storage/storage.go соответственно) соответственно)
• В своем проекте создайте новую учетную запись сервиса и дайте ей роль Cloud Run Invoker . Позже мы прикрепим эту учетную запись службы к заданию планировщика, чтобы регулярно запустить запуск набора данных.
• Убедитесь, что вы установили Gcloud CLI.
• Вы можете использовать task gcloud-setup для настройки gcloud для использования с этим проектом. В противном случае, обязательно настройте вручную.
• Отрегулируйте все экземпляры переменных PROJECT_ID , REGION и LOCATION найденных в Taskfile , чтобы соответствовать вашей конфигурации Google Cloud Project.

Развертывание набора данных и настройка задания планировщика

• Запустите task deploy-dataservice для создания и развертывания данных DataService. В конце вы получите URL -адрес услуги для недавно развернутого набора данных.
• Теперь, чтобы создать задание планировщика, запустите следующую команду. Обратите внимание на то, как мы передаем критическую информацию о безопасности в качестве переменных среды:

  DATASERVICE_URL=https://dataservice-ly6n5ozylq-od.a.run.app 
  SERVICE_ACCOUNT_EMAIL=[e-mail] 
  go-task create-dataservice-scheduler-job

• На этом этапе вы должны вручную подчеркнуть запуск DataService-JOB в консоли облачного планировщика. Это гарантирует, что хранилище объекта заполняется данными, прежде чем мы впервые запустим WebServer. Вы должны подождать примерно через 5 минут после этого, прежде чем развернуть веб -сервер, чтобы на DateRervice было время для получения и хранения новых данных.

Развертывание веб -сервера

Запустите task deploy-webserver . Никакой дальнейшей работы не требуется.

Тестирование

Тесты можно запускать с помощью включенного файла задачи.

• task test : запускает все испытательные задачи ниже.
• task test-storage : проверяет пакет storage , требует запуска Docker .

Внося

• Перед публикацией запроса на привлечение, пожалуйста, используйте go fmt для форматирования вашего кода.
• Новички с открытым исходным кодом приветствуются. Если вы хотите внести свой вклад, но не понимаете чего -то, вы можете попросить использовать проблему.
• Пожалуйста, опубликуйте запросы на функции в качестве одного выпуска за функцию.
• Прежде чем работать над более крупным вкладом, пожалуйста, откройте проблему, чтобы спросить, будет ли функция, которую вы хотите реализовать.
• Чтобы поддерживать прозрачный рабочий процесс, пожалуйста, продолжайте дискурс о работе над этим хранилищем в вопросах GitHub, не сообщайте мне по другим каналам, чтобы обсудить это.