quicky

Quicky Cli

Инструмент CLI, который оптимизирует развертывание и управление самостоятельными проектами next.js и node.js, обеспечивая инициализацию, развертывание из GitHub, обновление, удаление и управление приложениями, наряду с легкой настройкой доменов и сертификатов SSL, упрощение всего жизненного цикла веб-приложений на Remote Servers.

Функции

• ? Интеграция GitHub : инициализировать, развернуть и управлять проектами Next.js и Node.js из частных и публичных репозитории GitHub.
• Управление процессами : рычаг PM2 для жизненного цикла приложения и мониторинга.
• Техническое обслуживание проекта : легко обновлять или удалить развернутые проекты.
• Automation Domain & SSL : автоматическая настройка NGINX для пользовательских доменов и сертификатов SSL, позволяя добавлять/удалять домены из ваших проектов.
• Обзор конфигурации : Перечислите и проверяйте детали всех развернутых проектов и их доменов.
• ? Управление Webhook : настраивайте, управляйте и обновляют веб -крючки для автоматического развертывания.
• Доступ к панели управления : управление и контроль вашего сервера Webhook с помощью веб-панели мониторинга.
• ? Управление журналами : просмотреть вывод и журналы ошибок для вашего сервера Webhook.

Предварительные условия

Чтобы установить Quicky, сначала получите сервер Linux Ubuntu от поставщика, такого как DigitaloCean или Hetzner.

После настройки вашего сервера подключитесь к нему (например, через SSH) и установите Node.js и NPM, выполнив следующие команды:

sudo apt update
sudo apt install -y nodejs npm

Установка

Установите Quicky глобально, используя npx или npm :

npx quicky@latest install

или

sudo npm install -g quicky

Примечание . Команда sudo необходима для глобальной установки и для предотвращения проблем с разрешением при настройке доменов.

Использование

1. Инициализируйте быстро

quicky init

Эта команда побудит вас ввести ваши учетные данные GitHub и базовые конфигурации для настройки ваших проектов.

Quicky требует, чтобы ваш токен доступа GitHub и имя пользователя взаимодействует с вашими репозиториями. Чтобы создать новый токен, следуйте этим шагам:

1. Посетите свою страницу GitHub Personal Access Tokens и обязательно используйте токены (классические) .
2. Нажмите «Создать новый токен» .
3. Выберите необходимые области для доступа к репозитории.
4. Нажмите «Создать токен» .
5. Скопируйте токен и предоставьте его Quicky в качестве токена доступа GitHub. Этот токен будет храниться локально для будущего использования.

Чтобы обеспечить непрерывное развертывание, быстро запрашивает URL -адрес Webhook для автоматического развертывания. Он использует ваш токен GitHub, чтобы настроить прослушивателя веб -крюков и динамически создавать веб -хуки. Вам нужно будет создать субдомен (например, webhook.example.com ), указывающий на IP -адрес вашего сервера. Это можно сделать, добавив запись A с адресом IPv4 вашего сервера.

2. Развернуть проект

quicky deploy

Quicky теперь поддерживает развертывание проектов как Next.js , так и Node.js. В процессе развертывания вам будет предложено выбрать тип проекта:

• Next.js
• Node.js

Развертывание проекта Next.js

Следуйте подсказкам, чтобы выбрать ваш репозиторий Next.js. Quicky будет автоматически обрабатывать развертывание и конфигурацию.

Развертывание проекта Node.js

Прежде чем развернуть проект Node.js, убедитесь, что ваш основной файл приложения называется index.js . У вас есть возможность указать, будет ли ваш проект использовать порт:

• С портом : предоставьте номер порта (например, 3000). Quicky сохранит его в файле .env , позволяя вам направить домены в ваш проект.
• Без порта : без указания порта домены не могут быть направлены на проект, заставляя его работать исключительно в качестве фоновой службы.

Эта команда побудит вас предоставить:

• Ваше имя пользователя GitHub или любое название организации
• Название репозитория
• Тип проекта ( next.js или node.js )
• Если выбран node.js :
  • Использует ли ваш проект порт
    • Если да, номер порта, на котором должен работать проект (например, 3000)

Переменные среды - Во время развертывания вас спросят, хотите ли вы добавить переменные среды в свой проект. Quicky будет обрабатывать сохранение номера порта в файле .env вашего проекта, если это применимо.

3. Управление проектами

quicky manage

Перечисляет все развернутые проекты и позволяет запускать , останавливаться , перезапустить , обновить или удалять конкретный проект.

4. Обновить проект PID

quicky update < pid >

Обновляет конкретный проект по его PID с последними изменениями от репозитория GitHub.

5. Обзор конфигурации

quicky list

Отображает обзор всех развернутых проектов, включая следующие данные:

• PID : идентификатор проекта.
• Владелец : GitHub имени пользователя или название организации.
• Репозиторий : название репозитория GitHub.
• Порт : номер порта, на котором работает проект.
• Статус PM2 : текущее состояние процесса PM2.
• Последнее обновление : дата и время последнего развертывания/обновления.

6. Домены

Прежде чем добавить домен в ваш проект, вам нужно:

1. ? Купите доменное имя у регистратора, такого как Namecheap или GoDaddy.
2. Создайте запись A , указывающую на адрес IPv4 вашего сервера.

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

quicky domains

Эта команда позволяет вам легко добавлять и удалять домены и субдомены для ваших проектов.

7. Webhooks

Quicky предоставляет встроенный сервер Webhook для автоматического обновления ваших проектов, когда изменения направляются на GitHub. Вот как это настроить:

Настройка сервера Webhook

1. Предварительные условия

   • Убедитесь, что у вас есть субдомен (например, webhook.example.com), указывающий на IP -адрес вашего сервера
   • Добавьте запись DNS с адресом IPv4 вашего сервера

2. Начальная настройка

   quicky webhooks

   Эта команда будет:

   • Проверьте, работает ли сервер Webhook
   • Проведите вас через процесс настройки, если это необходимо
   • Приглашение на конфигурацию веб -крюка

3. Конфигурация

   • Вам нужно будет предоставить URL -адрес webhook (формат: https: /// webhook)
   • Сервер Webhook начнется автоматически после настройки

4. Проверьте настройку

   quicky webhooks status

   Это показывает:

   • Статус запуска сервера
   • Параметры для перезапуска/остановки сервера
   • Доступ к журналам серверов

Webhook Dashboard

1. Настройка доступа к панели панели

   quicky webhooks dashboard

   • Настройка имя пользователя и пароль
   • Условия надежно хранятся

2. Доступ к панели панели

   • Откройте свой браузер на https: /// Dashboard
   • Войдите в свои учетные данные
   • Мониторинг статуса веб -крюка
   • Просмотреть журналы Webhook

Управление веб -крючками

Используйте quicky webhooks с этими командами:

• status - Проверьте статус сервера Webhook
• restart - перезагрузить сервер WebHook
• stop - остановите сервер Webhook
• logs - Просмотреть журналы сервера Webhook
• dashboard - доступ к панели панели Webhook

8. Обновите быстро

quicky upgrade

Обновление быстро до последней версии.

9. Удалить быстрый

quicky uninstall

Удаляется быстро из вашей системы.

Лицензия

Этот проект лицензирован по лицензии MIT - для получения подробной информации см. Файл LICENSE .

Автор

• Алох

Не стесняйтесь связаться со мной? @Alemalohe, если у вас есть какие -либо вопросы или отзывы!

Внося

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