profile-summary-for-github README

The project's README from github.com/tipsy/profile-summary-for-github. As one markdown file: README.md.

Profile Summary   Badge License

A tool to visualize your GitHub presence.



Button Demo    Button Building    Button Usage 



profile-summary-for-github (tipsy/profile-summary-for-github)

Searching Database…

Что это такое?Инструмент для визуализации вашего присутствия на GitHub: он превращает профиль GitHub в наглядную сводную страницу вместо обычного вида профиля.
Это сайт, который кто-то хостит, или то, что я запускаю сам?Возможны оба варианта: это веб-приложение для самостоятельного размещения — бэкенд на Kotlin, построенный на фреймворке Javalin, который отдаёт фронтенд на Vue в ваш браузер.
Как его запустить?В репозитории есть поддержка Docker, поэтому самый быстрый путь — запустить его как контейнер; сборка из исходников описана в Documentation/Building.md.
Нужно ли что-то ещё, кроме Docker, чтобы его запустить?Нет — это один самодостаточный веб-сервис без отдельного клиента, который нужно устанавливать; когда сервер запущен, вы просто открываете его в браузере.
Он запустится на моём компьютере или ему нужен нормальный сервер?И то и другое: бэкенд — это JVM-приложение, которое работает везде, где работает Docker или Java, — на ноутбуке, домашнем сервере или VPS, а интерфейс — обычная веб-страница.
Откуда он берёт данные, которые визуализирует?Прямо из GitHub через его API — проект построен на GitHub API, поэтому он делает сводку по онлайн-профилю GitHub, а не сканирует ваши локальные репозитории.
Есть ли живое демо, которое можно посмотреть перед самостоятельным хостингом?Да — в README сразу наверху есть кнопка Demo рядом с документацией по сборке (Building) и использованию (Usage), так что можно посмотреть, как выглядит обработанный профиль, ничего не устанавливая.
Creator
tipsy
Size
3.2 MB
Stars
19.9K
Updated
CommitFeb 22
Age
8y
Commits · 90 Days