Jump Jump

Открываем коробку и сразу используем, это функциональная система коротких ссылок, разработанная на Golang.

Введение

Прыжок-прыжок

Открываем коробку и используем, это функциональная система коротких ссылок, разработанная на Golan.

• [Быстрый опыт](#Быстрый опыт)
• [Функции и использование](#Функции и использование)
  • [Снимок экрана](#Снимок экрана)
• [Запуск на локальном компьютере](#Запуск на локальном компьютере)
• [Как получить доступ к коротким ссылкам?](#Как получить доступ к коротким ссылкам?)
  • [Настройка домена для коротких ссылок](#Настройка домена для коротких ссылок)
  • [Получение полной короткой ссылки](#Получение полной короткой ссылки)
• [Развертывание на сервере](#Развертывание на сервере)
• [Документация по интерфейсу](#Документация по интерфейсу)
• Благодарность

Быстрый опыт

Посетите здесь, чтобы испытать Jump Jump! (Учетная запись / пароль для тестирования: guest / guest).

Функции и использование

Функциональный модуль, вы можете следить за будущими функциями и планами в разделе «Проблемы»:

Снимок экрана

Запуск на локальном компьютере

Используйте docker-compose для запуска, который может быстро помочь вам запустить redis, apiserver, landingserver. Используйте следующую команду:

# Клонируйте или загрузите исходный код проекта на свой компьютер
git clone https://github.com/jwma/jump-jump.git

# Перейдите в каталог исходного кода проекта
cd jump-jump/

# Создайте образ контейнера на своем компьютере
make dockerimage

# Запустите
docker-compose -f deployments/docker-compose.yaml -p jumpjump up -d

# Проверьте статус работы службы
docker-compose -f deployments/docker-compose.yaml -p jumpjump ps

# Если вы видите, что apiserver / landingserver не запустился успешно, перезапустите его, чтобы решить проблему
docker-compose -f deployments/docker-compose.yaml -p jumpjump restart

# Создать пользователя, при нормальной работе службы, выполнить createuser, чтобы создать пользователя, используйте следующее
docker-compose -f deployments/docker-compose.yaml -p jumpjump exec apiserver ./createuser --help

Использование ./createuser:
  -password string
        пароль.
  -role int
        роль, 1: обычный пользователь, 2: администратор. (по умолчанию 1)
  -username string
        имя пользователя.

# Создание пользователя с ролью администратора
docker-compose -f deployments/docker-compose.yaml -p jumpjump exec apiserver ./createuser -username=mj
 -password=12345 -role=2

После успешного запуска службы и создания пользователя вы можете открыть браузер и посетить http://localhost:8080, чтобы войти в систему управления и управлять короткими ссылками.

Как получить доступ к коротким ссылкам?

Настройка домена для коротких ссылок

Войдите в систему управления после запуска службы. Вы можете увидеть настройки домена для коротких ссылок (только администраторы могут изменять их). Здесь вы можете установить домен или IP-адрес: порт, на котором развернута служба, например: http://127.0.0.1:8000/ или http://yourdomain.com/ Обратите внимание, что он должен заканчиваться /.

Получение полной короткой ссылки

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

Pin

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

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

Здесь предлагается план развертывания с использованием docker-compose, нажмите здесь, чтобы просмотреть.

Документация по интерфейсу

Swagger UI предоставляет документ для отладки. Для получения подробной информации см. этот PR. Надеемся, этот документ поможет всем!

Благодарность

Спасибо всем, кто предложил улучшения и сообщил об ошибках в Jump Jump. Без вас Jump Jump не был бы таким хорошим!