Skip to content

README.ru.md

Latest commit

 

History

History
153 lines (101 loc) · 7.5 KB

README.ru.md

File metadata and controls

153 lines (101 loc) · 7.5 KB

⚠️ Примечание о переводе: Этот документ был переведен с помощью ИИ. Если вы найдете ошибки, пожалуйста, сообщите о них. Спасибо!

Этот проект является форком star-history/star-history и был улучшен. Он не будет объединять код обратно в оригинальный проект. Проект обновляет реализацию графиков и вводит MongoDB для кэширования данных, что снижает количество запросов к GitHub API и повышает производительность. Добавлена тёмная тема.

✨ gitdata analysis ✨

gitdata.xuanhun520.com, предоставляет недостающие возможности статистики и визуализации данных для репозиториев GitHub, такие как функциональность графиков истории звезд.

Star History Chart

👆 ЭТО живой график, созданный с помощью следующего HTML-кода: 👇

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://gitdata.xuanhun520.com/api/starimg?repos=visactor/vchart&type=Date&theme=dark" />
  <source media="(prefers-color-scheme: light)" srcset="https://gitdata.xuanhun520.com/api/starimg?repos=visactor/vchart&type=Date" />
  <img style="width: 800px; height: 533px;" alt="Star History Chart" src="https://gitdata.xuanhun520.com/api/starimg?repos=visactor/vchart&type=Date" />
</picture>

✨ Возможности

  • Основано на VChart.
  • Поддержка просмотра детальных данных
  • Генерация одним кликом высококачественных изображений графиков;
  • Поддержка нескольких режимов просмотра графиков, на основе даты или временной шкалы;
  • Встраивание графиков в реальном времени в GitHub readme или другие веб-сайты (как пример, который мы встроили вверху);
  • И различные полезные функции:
    • Переключение видимости репозитория;
    • Горячая клавиша для ввода имени репозитория;
    • Быстрая публикация в социальных сетях;
    • Поддержка ввода нескольких репозиториев;
    • ...больше функций ждут, чтобы их открыли!

🌠 Скриншоты

🏗 Разработка

Star-history построен с использованием современного технологического стека: Vue + Vite + TailwindCSS + @Visactor/VChart.

Требования

Установка зависимостей

pnpm i

Начало разработки

  • Главный веб-сайт — это домашняя страница gitdata, содержащая большинство полезных функций и блогов о VisActor open source.

    pnpm dev

    Веб-сайт будет доступен по адресу http://localhost:3000.

  • API-сервер — это экспериментальная функция. Он в основном используется для генерации файлов изображений графиков SVG или PNG, которые можно встроить в GitHub readme.

    Требования для API-сервера

    Установка MongoDB Community Server

    Примечание: После изменения пароля не забудьте обновить строку подключения в вашем файле .env или переменных окружения.

    Установка переменных окружения:

    Конфигурация MongoDB может быть изменена в соответствии с вашей фактической ситуацией.

    # Установка строки подключения MongoDB
export MONGODB_URI="mongodb://[username]:[password]@localhost:27017/gitdata"
export MONGODB_DB_NAME="gitdata"
export MONGODB_COLLECTION_NAME="repo_cache"

    Или создайте файл .env в директории server:

    MONGODB_URI=mongodb://xuanhun:xuanhun@localhost:27017/gitdata
MONGODB_DB_NAME=gitdata
MONGODB_COLLECTION_NAME=repo_cache

    Запуск API-сервера

    cd server
pnpm i && pnpm dev

    API-сервер будет работать на http://localhost:8080 (или https://localhost:8080, если включен HTTPS).

    Токен

    Сервису бэкенда требуется ваш собственный токен GitHub, размещенный в файле token.env.

    Включение поддержки HTTPS

    Чтобы включить HTTPS для фронтенда:

    1. Генерация SSL-сертификатов (для разработки):

      ./scripts/generate-ssl-cert.sh

      Это создаст самоподписанные сертификаты в директории certs/.

    2. Для фронтенда (Vite):

      Сервер разработки Vite автоматически будет использовать HTTPS, если сертификаты найдены в директории certs/, или вы можете указать пользовательские пути:

      export SSL_CERT_PATH=/path/to/cert.crt
export SSL_KEY_PATH=/path/to/key.key
pnpm dev

Планы на будущее

  • Добавить больше функций редактирования и аннотаций
  • Просмотр и редактирование кода VChart, экспорт в официальный редактор VChart
  • Генерация анимированных видео истории звезд (GIF)
  • Больше статистики и функций анализа данных GitHub