quicky

Quicky Cli

자체 호스팅 된 Next.js 및 Node.js 프로젝트의 배포 및 관리를 간소화하여 초기화, GitHub의 배포, 애플리케이션 업데이트, 삭제 및 관리 및 원격 서버에서 웹 애플리케이션의 전체 라이프 사이클을 단순화하면서 초기화, GitHub에서의 배포, 삭제 및 관리 및 관리를 가능하게하는 CLI 도구입니다.

특징

• ? GitHub 통합 : 개인 및 공개 GitHub 리포지토리에서 Next.js 및 Node.js 프로젝트를 초기화, 배포 및 관리합니다.
• 프로세스 관리 : 애플리케이션 라이프 사이클 및 모니터링을 위해 PM2를 활용합니다.
• 프로젝트 유지 보수 : 배포 된 프로젝트를 쉽게 업데이트하거나 제거합니다.
• Domain & SSL Automation : 사용자 정의 도메인 및 SSL 인증서에 대한 Nginx를 자동으로 구성하여 프로젝트에서 도메인을 추가/제거 할 수 있습니다.
• 구성 개요 : 모든 배포 된 프로젝트 및 해당 도메인의 세부 사항을 목록 및 검사합니다.
• ? Webhook Management : 자동 배포를 위해 WebHooks를 설정, 관리 및 업데이트하십시오.
• 대시 보드 액세스 : 웹 기반 대시 보드를 통해 WebHook 서버를 관리하고 모니터링합니다.
• ? 로그 관리 : WebHook 서버의 출력 및 오류 로그보기.

전제 조건

Quicky를 설치하려면 먼저 DigitalOcean 또는 Hetzner와 같은 제공자에서 Linux Ubuntu 서버를 획득하십시오.

서버를 설정 한 후 서버 (예 : SSH를 통해)에 연결하고 다음 명령을 실행하여 Node.js 및 NPM을 설치하십시오.

sudo apt update
sudo apt install -y nodejs npm

설치

npx 또는 npm 사용하여 전 세계적으로 Quicky를 설치하십시오.

npx quicky@latest install

또는

sudo npm install -g quicky

참고 : sudo 명령은 전역 설치 및 도메인을 구성 할 때 권한 문제를 방지하기 위해 필요합니다.

용법

1. Quicky를 초기화하십시오

quicky init

이 명령은 프로젝트 설정을위한 GitHub 자격 증명 및 기본 구성을 입력하라는 메시지를 표시합니다.

Quicky는 Github 액세스 토큰 및 사용자 이름이 저장소와 상호 작용하도록 요구합니다. 새 토큰을 만들려면 다음 단계를 따르십시오.

1. GitHub 개인 액세스 토큰 페이지를 방문하여 토큰 (클래식) 을 사용하십시오.
2. 새 토큰을 클릭하십시오.
3. 저장소 액세스에 필요한 스코프를 선택하십시오.
4. 토큰 생성을 클릭하십시오.
5. 토큰을 복사하여 Github 액세스 토큰으로 Quicky에 제공하십시오. 이 토큰은 향후 사용하기 위해 로컬로 저장됩니다.

연속 배포를 가능하게하려면 Quicky는 자동 배포에 대한 WebHook URL을 요청합니다. GitHub 토큰을 사용하여 WebHook 리스너를 설정하고 WebHooks를 동적으로 만듭니다. 서버의 IP 주소를 가리키는 하위 도메인 (예 : webhook.example.com )을 만들어야합니다. 서버의 IPv4 주소와 함께 A DNS 레코드를 추가하여 수행 할 수 있습니다.

2. 프로젝트를 배포하십시오

quicky deploy

Quicky는 이제 Next.js 및 Node.js 프로젝트를 모두 배포하는 것을 지원합니다. 배포 과정에서 프로젝트 유형을 선택하라는 메시지가 표시됩니다.

• 다음 .js
• node.js

다음.js 프로젝트를 배포합니다

프롬프트를 따르면 다음에 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 >

GitHub 저장소의 최신 변경 사항으로 PID로 특정 프로젝트를 업데이트합니다.

5. 구성 개요

quicky list

다음 세부 정보를 포함하여 모든 배포 된 프로젝트의 개요를 표시합니다.

• PID : 프로젝트 ID.
• 소유자 : Github 사용자 이름 또는 조직 이름.
• 저장소 : Github 저장소 이름.
• 포트 : 프로젝트가 실행중인 포트 번호.
• PM2 상태 : PM2 프로세스의 현재 상태.
• 마지막 업데이트 : 마지막 배포/업데이트의 날짜 및 시간.

6. 도메인

프로젝트에 도메인을 추가하기 전에 다음을 수행해야합니다.

1. ? Namecheap 또는 Godaddy와 같은 레지스트라에서 도메인 이름을 구입하십시오 .
2. 서버의 IPv4 주소를 가리키는 A DNS 레코드를 만듭니다 .

도메인이 있으면 다음 명령으로 도메인을 쉽게 관리 할 수 있습니다.

quicky domains

이 명령을 사용하면 프로젝트의 도메인 및 하위 도메인을 쉽게 추가 하고 제거 할 수 있습니다.

7. Webhooks

Quicky는 내장 된 WebHook 서버를 제공하여 변경 사항이 GitHub로 푸시 될 때 프로젝트를 자동으로 업데이트합니다. 설정하는 방법은 다음과 같습니다.

WebHook 서버 설정

1. 전제 조건

   • 서버의 IP 주소를 가리키는 하위 도메인 (예 : webhook.example.com)이 있는지 확인하십시오.
   • 서버의 IPv4 주소로 DNS 레코드 추가

2. 초기 설정

   quicky webhooks

   이 명령은 다음과 같습니다.

   • WebHook 서버가 실행 중인지 확인하십시오
   • 필요한 경우 설정 프로세스를 안내하십시오
   • WebHook 구성을 자랑스럽게 생각합니다

3. 구성

   • Webhook URL (형식 : https : ///webhook)을 제공해야합니다.
   • 설정 후 WebHook 서버가 자동으로 시작됩니다

4. 설정을 확인하십시오

   quicky webhooks status

   이것은 다음을 보여줍니다 :

   • 서버 실행 상태
   • 서버를 다시 시작/정지하는 옵션
   • 서버 로그에 대한 액세스

Webhook 대시 보드

1. 대시 보드 액세스를 설정합니다

   quicky webhooks dashboard

   • 사용자 이름과 비밀번호를 설정하십시오
   • 자격 증명은 안전하게 저장됩니다

2. 액세스 대시 보드

   • 브라우저를 https : /// 대시 보드로 엽니 다
   • 자격 증명으로 로그인하십시오
   • WebHook 상태를 모니터링하십시오
   • WebHook 로그를 봅니다

WebHooks 관리

이 명령과 함께 quicky webhooks 사용하십시오.

• status - WebHook 서버 상태를 확인합니다
• restart - WebHook 서버를 다시 시작하십시오
• stop - Webhook 서버를 중지하십시오
• logs - WebHook 서버 로그를 봅니다
• dashboard - WebHook 대시 보드에 액세스하십시오

8. Quicky를 업그레이드하십시오

quicky upgrade

최신 버전으로 빠르게 업그레이드합니다.

9. Quicky를 제거하십시오

quicky uninstall

시스템에서 Quicky를 제거합니다.

특허

이 프로젝트는 MIT 라이센스에 따라 라이센스가 부여됩니다. 자세한 내용은 LICENSE 파일을 참조하십시오.

작가

• alohe

저에게 연락을 드리겠습니다. 질문이나 피드백이 있으면 @alemalohe!

기여

기부금을 환영합니다! 시작 방법에 대한 지침은 기고 파일을 읽으십시오.