quicky

CLI rápida

Uma ferramenta de CLI que otimiza a implantação e o gerenciamento de projetos auto-hospedados a seguir.js e node.js, permitindo a inicialização, a implantação do GitHub, atualizando, excluindo e gerenciando aplicativos, juntamente com a configuração sem esforço de domínios e certificados SSL, simplificando todo o ciclo de vida dos aplicativos da Web em servidores remetentes.

Características

• ? Integração do Github : Inicialize, implante e gerencie projetos Next.js e Node.js de repositórios privados e públicos do GitHub.
• Gerenciamento de processos : alavancar PM2 para ciclo de vida e monitoramento do aplicativo.
• Manutenção do projeto : atualize ou remova facilmente projetos implantados.
• Automação de domínio e SSL : configure automaticamente o nginx para domínios personalizados e certificados SSL, permitindo adicionar/remover domínios de seus projetos.
• Visão geral da configuração : Liste e inspecione detalhes de todos os projetos implantados e seus domínios.
• ? Webhook Management : Configure, gerencie e atualize webhooks para implantações automatizadas.
• Acesso ao painel : Gerencie e monitore seu servidor webhook por meio de um painel baseado na Web.
• ? Gerenciamento de log : visualize logs de saída e erro para o seu servidor webhook.

Pré -requisitos

Para instalar rapidamente, adquirir um servidor Linux Ubuntu de um provedor como Digitalocean ou Hetzner.

Depois de configurar seu servidor, conecte -se a ele (por exemplo, via SSH) e instale o Node.js e o NPM, executando os seguintes comandos:

sudo apt update
sudo apt install -y nodejs npm

Instalação

Instale o rápido globalmente usando npx ou npm :

npx quicky@latest install

ou

sudo npm install -g quicky

Nota : O comando sudo é necessário para a instalação global e para evitar problemas de permissão ao configurar domínios.

Uso

1. Inicialize rapidamente

quicky init

Este comando solicitará que você insira suas credenciais e configurações básicas do GitHub para configurar seus projetos.

O Quicky requer seu token de acesso ao github e nome de usuário para interagir com seus repositórios. Para criar um novo token, siga estas etapas:

1. Visite sua página de tokens de acesso pessoal do Github e certifique -se de usar tokens (clássico) .
2. Clique em Gerar novo token .
3. Selecione os escopos necessários para acesso ao repositório.
4. Clique em Gerar token .
5. Copie o token e forneça -o rapidamente como seu token de acesso ao GitHub. Este token será armazenado localmente para uso futuro.

Para ativar a implantação contínua, solicita rápida um URL da webhook para implantações automatizadas. Ele usa o seu token do github para configurar um ouvinte webhook e criar webhooks dinamicamente. Você precisará criar um subdomínio (por exemplo, webhook.example.com ) apontando para o endereço IP do servidor. Isso pode ser feito adicionando um registro A DNS com o endereço IPv4 do seu servidor.

2. Implante um projeto

quicky deploy

O Quicky agora suporta a implantação de projetos Next.js e Node.js. Durante o processo de implantação, você será solicitado a selecionar o tipo de projeto:

• Next.js
• Node.js

Implantando um projeto Next.js

Siga os avisos para selecionar seu próximo.js repositório. O Quicky lidará com a implantação e a configuração automaticamente.

Implantando um projeto Node.js

Antes de implantar um projeto Node.js, verifique se o seu arquivo de aplicativo principal é nomeado index.js . Você tem a opção de especificar se o seu projeto usará uma porta:

• Com porta : forneça o número da porta (por exemplo, 3000). O Quicky o salvará no arquivo .env , permitindo que você aponte domínios para o seu projeto.
• Sem porta : sem especificar uma porta, os domínios não podem ser direcionados para o projeto, fazendo com que ele opere apenas como um serviço em segundo plano.

Este comando solicitará que você forneça:

• Seu nome de usuário do github ou qualquer nome da organização
• O nome do repositório
• Tipo de projeto ( Next.js ou Node.js )
• Se Node.js estiver selecionado:
  • Se o seu projeto usa uma porta
    • Se sim, o número da porta em que o projeto deve ser executado (por exemplo, 3000)

Variáveis de ambiente - Durante a implantação, você será perguntado se deseja adicionar variáveis de ambiente ao seu projeto. O Quicky lidará com a economia do número da porta no arquivo .env do seu projeto, se aplicável.

3. Gerencie projetos

quicky manage

Lista todos os projetos implantados e permite iniciar , parar , reiniciar , atualizar ou excluir um projeto específico.

4. Atualize um projeto por PID

quicky update < pid >

Atualiza um projeto específico por seu PID com as últimas alterações do repositório do GitHub.

5. Visão geral da configuração

quicky list

Exibe uma visão geral de todos os projetos implantados, incluindo os seguintes detalhes:

• PID : ID do projeto.
• Proprietário : nome de usuário do github ou nome da organização.
• Repositório : Nome do repositório do GitHub.
• Porta : número da porta no qual o projeto está em execução.
• Status do PM2 : status atual do processo PM2.
• Última atualização : data e hora da última implantação/atualização.

6. Domínios

Antes de adicionar um domínio ao seu projeto, você precisa:

1. ? Compre um nome de domínio de um registrador como Namecheap ou GoDaddy.
2. Crie um registro A DNS apontando para o endereço IPv4 do seu servidor.

Depois de ter seu domínio, você pode gerenciá -lo facilmente com o seguinte comando:

quicky domains

Este comando permite que você adicione e remova sem esforço domínios e subdomínios para seus projetos.

7. Webhooks

O Quicky fornece um servidor webhook embutido para atualizar automaticamente seus projetos quando as alterações são empurradas para o GitHub. Veja como configurá -lo:

Configurando o servidor webhook

1. Pré -requisitos

   • Certifique -se de ter um subdomínio (por exemplo, webhook.example.com) apontando para o endereço IP do servidor
   • Adicione um registro A DNS com o endereço IPv4 do seu servidor

2. Configuração inicial

   quicky webhooks

   Este comando vai:

   • Verifique se o servidor webhook está em execução
   • Guiá -lo através do processo de configuração, se necessário
   • Prompt for Webhook Configuration

3. Configuração

   • Você precisará fornecer um URL da webhook (formato: https: /// webhook)
   • O servidor webhook começará automaticamente após a configuração

4. Verifique a configuração

   quicky webhooks status

   Isso mostra:

   • Status de execução do servidor
   • Opções para reiniciar/parar o servidor
   • Acesso a logs do servidor

Painel de webhook

1. Configurar acesso ao painel

   quicky webhooks dashboard

   • Configure o nome de usuário e a senha
   • Credenciais são armazenadas com segurança

2. Painel de acesso

   • Abra seu navegador para https: /// painel
   • Faça login com suas credenciais
   • Monitore o status da webhook
   • Veja os logs do webhook

Gerenciando webhooks

Use quicky webhooks com estes comandos:

• status - Verifique o status do servidor webhook
• restart - reinicie o servidor webhook
• stop - pare o servidor webhook
• logs - Exibir logs do servidor Webhook
• dashboard - Acesse o painel Webhook

8. Atualize a rapidez

quicky upgrade

Atualiza rapidamente para a versão mais recente.

9. Desinstale rapidamente

quicky uninstall

Remove rapidamente do seu sistema.

Licença

Este projeto está licenciado sob a licença do MIT - consulte o arquivo LICENSE para obter detalhes.

Autor

• Alohe

Sinta -se à vontade para entrar em contato comigo? @alemalohe Se você tiver alguma dúvida ou feedback!

Contribuindo

As contribuições são bem -vindas! Leia o arquivo contribuinte para obter diretrizes sobre como começar.