quicky

CLI Quicky

Alat CLI yang merampingkan penyebaran dan pengelolaan proyek selanjutnya yang di-host-self-host dan node.js, memungkinkan inisialisasi, penyebaran dari GitHub, memperbarui, menghapus, dan mengelola aplikasi, bersama dengan pengaturan domain yang mudah dan sertifikat SSL, menyederhanakan seluruh siklus hidup aplikasi Web pada server remote.

Fitur

• ? Integrasi GitHub : Inisialisasi, Menyebarkan, dan mengelola proyek Next.js dan Node.js dari repositori gitub swasta dan publik.
• Manajemen Proses : Leverage PM2 untuk siklus hidup dan pemantauan aplikasi.
• Pemeliharaan Proyek : Mudah memperbarui atau menghapus proyek yang digunakan.
• Otomatisasi Domain & SSL : Secara otomatis mengkonfigurasi NGINX untuk domain khusus dan sertifikat SSL, memungkinkan Anda untuk menambah/menghapus domain dari proyek Anda.
• Tinjauan Konfigurasi : Daftar dan periksa detail dari semua proyek yang digunakan dan domainnya.
• ? WebHook Management : Mengatur, mengelola, dan memperbarui WebHooks untuk penyebaran otomatis.
• Akses Dasbor : Kelola dan pantau server webhook Anda melalui dasbor berbasis web.
• ? Manajemen Log : Lihat output dan log kesalahan untuk server webhook Anda.

Prasyarat

Untuk menginstal Quicky, pertama -tama dapatkan server Linux Ubuntu dari penyedia seperti Digitalocean atau Hetzner.

Setelah menyiapkan server Anda, sambungkan ke sana (misalnya, melalui SSH) dan instal Node.js dan NPM dengan menjalankan perintah berikut:

sudo apt update
sudo apt install -y nodejs npm

Instalasi

Instal Quicky secara global menggunakan npx atau npm :

npx quicky@latest install

atau

sudo npm install -g quicky

Catatan : Perintah sudo diperlukan untuk instalasi global dan untuk mencegah masalah izin saat mengonfigurasi domain.

Penggunaan

1. Inisialisasi Quicky

quicky init

Perintah ini akan meminta Anda untuk memasukkan kredensial github dan konfigurasi dasar untuk menyiapkan proyek Anda.

Quicky membutuhkan token akses dan nama pengguna GitHub Anda untuk berinteraksi dengan repositori Anda. Untuk membuat token baru, ikuti langkah -langkah ini:

1. Kunjungi halaman Token Akses Pribadi GitHub Anda dan pastikan untuk menggunakan token (klasik) .
2. Klik menghasilkan token baru .
3. Pilih lingkup yang diperlukan untuk akses repositori.
4. Klik menghasilkan token .
5. Salin token dan berikan ke Quicky sebagai token akses github Anda. Token ini akan disimpan secara lokal untuk penggunaan di masa depan.

Untuk mengaktifkan penyebaran berkelanjutan, Quicky meminta URL webhook untuk penyebaran otomatis. Ini menggunakan token GitHub Anda untuk mengatur pendengar webhook dan membuat webhooks secara dinamis. Anda harus membuat subdomain (misalnya, webhook.example.com ) menunjuk ke alamat IP server Anda. Ini dapat dilakukan dengan menambahkan catatan A DNS dengan alamat IPv4 server Anda.

2. Menyebarkan proyek

quicky deploy

Quicky sekarang mendukung penyebaran proyek Next.js dan Node.js. Selama proses penempatan, Anda akan diminta untuk memilih jenis proyek:

• Next.js
• Node.js

Menyebarkan proyek Next.js

Ikuti prompt untuk memilih repositori selanjutnya.js Anda. Quicky akan menangani penyebaran dan konfigurasi secara otomatis.

Menyebarkan proyek Node.js

Sebelum menggunakan proyek Node.js, pastikan bahwa file aplikasi utama Anda bernama index.js . Anda memiliki opsi untuk menentukan apakah proyek Anda akan menggunakan port:

• Dengan port : berikan nomor port (misalnya, 3000). Quicky akan menyimpannya di file .env , memungkinkan Anda untuk mengarahkan domain ke proyek Anda.
• Tanpa port : Tanpa menentukan port, domain tidak dapat diarahkan ke proyek, menyebabkannya beroperasi semata -mata sebagai layanan latar belakang.

Perintah ini akan meminta Anda untuk menyediakan:

• Nama pengguna GitHub Anda atau nama organisasi apa pun
• Nama repositori
• Jenis Proyek ( Next.js atau Node.js )
• Jika Node.js dipilih:
  • Apakah proyek Anda menggunakan port
    • Jika ya, nomor port tempat proyek harus dijalankan (misalnya, 3000)

Variabel Lingkungan - Selama penyebaran, Anda akan ditanya apakah Anda ingin menambahkan variabel lingkungan ke proyek Anda. Quicky akan menangani menyimpan nomor port di file .env proyek Anda jika berlaku.

3. Kelola proyek

quicky manage

Daftar semua proyek yang digunakan dan memungkinkan Anda untuk memulai , menghentikan , memulai kembali , memperbarui , atau menghapus proyek tertentu.

4. Perbarui proyek dengan PID

quicky update < pid >

Memperbarui proyek tertentu dengan PID -nya dengan perubahan terbaru dari repositori GitHub.

5. Ikhtisar Konfigurasi

quicky list

Menampilkan ikhtisar semua proyek yang digunakan, termasuk detail berikut:

• PID : ID Proyek.
• Pemilik : Nama pengguna atau nama organisasi GitHub.
• Repositori : Nama repositori GitHub.
• Port : Nomor port tempat proyek berjalan.
• Status PM2 : Status saat ini dari proses PM2.
• Terakhir Diperbarui : Tanggal dan Waktu Penerapan/Pembaruan Terakhir.

6. Domain

Sebelum menambahkan domain ke proyek Anda, Anda harus:

1. ? Beli nama domain dari pendaftar seperti Namecheap atau GoDaddy.
2. Buat catatan A DNS yang menunjuk ke alamat IPv4 server Anda.

Setelah Anda memiliki domain, Anda dapat dengan mudah mengelolanya dengan perintah berikut:

quicky domains

Perintah ini memungkinkan Anda untuk dengan mudah menambah dan menghapus domain dan subdomain untuk proyek Anda.

7. Webhooks

Quicky menyediakan server webhook bawaan untuk secara otomatis memperbarui proyek Anda ketika perubahan didorong ke GitHub. Inilah cara mengaturnya:

Menyiapkan server webhook

1. Prasyarat

   • Pastikan Anda memiliki subdomain (misalnya, webhook.example.com) yang menunjuk ke alamat IP server Anda
   • Tambahkan catatan A DNS dengan alamat IPv4 server Anda

2. Pengaturan Awal

   quicky webhooks

   Perintah ini akan:

   • Periksa apakah server webhook sedang berjalan
   • Memandu Anda melalui proses pengaturan jika diperlukan
   • Prompt untuk konfigurasi webhook

3. Konfigurasi

   • Anda harus menyediakan URL webhook (format: https: /// webhook)
   • Server webhook akan mulai secara otomatis setelah diatur

4. Verifikasi Pengaturan

   quicky webhooks status

   Ini menunjukkan:

   • Status menjalankan server
   • Opsi untuk memulai kembali/menghentikan server
   • Akses ke Log Server

Dasbor Webhook

1. Mengatur akses dasbor

   quicky webhooks dashboard

   • Siapkan Nama Pengguna dan Kata Sandi
   • Kredensial disimpan dengan aman

2. Akses dasbor

   • Buka browser Anda ke https: /// dasbor
   • Masuk dengan kredensial Anda
   • Pantau status webhook
   • Lihat Log Webhook

Mengelola Webhooks

Gunakan quicky webhooks dengan perintah ini:

• status - Periksa Status Server Webhook
• restart - restart server webhook
• stop - Hentikan Server Webhook
• logs - Lihat Log Server Webhook
• dashboard - Akses dasbor webhook

8. Tingkatkan Quicky

quicky upgrade

Upgrade Quicky ke versi terbaru.

9. Uninstall Quicky

quicky uninstall

Menghapus Quicky dari sistem Anda.

Lisensi

Proyek ini dilisensikan di bawah lisensi MIT - lihat file LICENSE untuk detailnya.

Pengarang

• Alohe

Jangan ragu untuk menghubungi saya? @Alemalohe Jika Anda memiliki pertanyaan atau umpan balik!

Berkontribusi

Kontribusi dipersilakan! Harap baca file yang berkontribusi untuk panduan tentang cara memulai.