A CLI tool that streamlines the deployment and management of self-hosted Next.js and Node.js projects, enabling initialization, deployment from GitHub, updating, deleting, and managing applications, along with effortless setup of domains and SSL certificates, simplifying the entire lifecycle of web applications on remote servers.
- π GitHub Integration: Initialize, deploy, and manage Next.js and Node.js projects from private and public GitHub repositories.
- βοΈ Process Management: Leverage PM2 for application lifecycle and monitoring.
- π Project Maintenance: Easily update or remove deployed projects.
- π Domain & SSL Automation: Automatically configure Nginx for custom domains and SSL certificates, allowing you to add/remove domains from your projects.
- π Configuration Overview: List and inspect details of all deployed projects and their domains.
- π§ Webhook Management: Set up, manage, and update webhooks for automated deployments.
- π Dashboard Access: Manage and monitor your webhook server through a web-based dashboard.
- π Log Management: View output and error logs for your webhook server.
To install Quicky, first acquire a Linux Ubuntu server from a provider such as DigitalOcean or Hetzner.
After setting up your server, connect to it (e.g., via SSH) and install Node.js and npm by executing the following commands:
sudo apt update
sudo apt install -y nodejs npmInstall Quicky globally using either npx or npm:
npx quicky@latest installor
sudo npm install -g quickyNote: The sudo command is necessary for global installation and to prevent permission issues when configuring domains.
quicky initThis command will prompt you to enter your GitHub credentials and basic configurations for setting up your projects.
Quicky requires your GitHub access token and username to interact with your repositories. To create a new token, follow these steps:
- Visit your GitHub Personal Access Tokens page and make sure to use Tokens (classic).
- Click Generate new token.
- Select the required scopes for repository access.
- Click Generate token.
- Copy the token and provide it to Quicky as your GitHub access token. This token will be stored locally for future use.
To enable Continuous Deployment, Quicky requests a webhook URL for automated deployments.
It uses your GitHub token to set up a webhook listener and create webhooks dynamically.
You'll need to create a subdomain (e.g., webhook.example.com) pointing to your server's IP address. This can be done by adding an A DNS record with the IPv4 address of your server.
quicky deployQuicky now supports deploying both Next.js and Node.js projects. During the deployment process, you will be prompted to select the project type:
- Next.js
- Node.js
Follow the prompts to select your Next.js repository. Quicky will handle the deployment and configuration automatically.
Before deploying a Node.js project, ensure that your main application file is named index.js. You have the option to specify whether your project will use a port:
- With Port: Provide the port number (e.g., 3000). Quicky will save it in the
.envfile, allowing you to point domains to your project. - Without Port: Without specifying a port, domains cannot be directed to the project, causing it to operate solely as a background service.
This command will prompt you to provide:
- Your GitHub username or any organization name
- The repository name
- Project type (Next.js or Node.js)
- If Node.js is selected:
- Whether your project uses a port
- If yes, the port number on which the project should run (e.g., 3000)
- Whether your project uses a port
Environment Variables - During deployment, you'll be asked whether you'd like to add environment variables to your project. Quicky will handle saving the port number in the .env file of your project if applicable.
quicky manageLists all deployed projects and allows you to start, stop, restart, update, or delete a specific project.
quicky update <pid>Updates a specific project by its PID with the latest changes from the GitHub repository.
quicky listDisplays an overview of all deployed projects, including the following details:
- PID: Project ID.
- Owner: GitHub username or organization name.
- Repository: Name of the GitHub repository.
- Port: Port number on which the project is running.
- PM2 Status: Current status of the PM2 process.
- Last updated: Date and time of the last deployment/update.
Before adding a domain to your project, you need to:
- π Purchase a domain name from a registrar like Namecheap or GoDaddy.
- π Create an
ADNS record pointing to your server's IPv4 address.
Once you have your domain, you can easily manage it with the following command:
quicky domainsThis command allows you to effortlessly add and remove domains and subdomains for your projects.
Quicky provides a built-in webhook server to automatically update your projects when changes are pushed to GitHub. Here's how to set it up:
-
Prerequisites
- Ensure you have a subdomain (e.g., webhook.example.com) pointing to your server's IP address
- Add an A DNS record with your server's IPv4 address
-
Initial Setup
quicky webhooks
This command will:
- Check if the webhook server is running
- Guide you through the setup process if needed
- Prompt for webhook configuration
-
Configuration
- You'll need to provide a webhook URL (format: https:///webhook)
- The webhook server will start automatically after setup
-
Verify Setup
quicky webhooks status
This shows:
- Server running status
- Options to restart/stop server
- Access to server logs
-
Setup Dashboard Access
quicky webhooks dashboard
- Set up username and password
- Credentials are securely stored
-
Access Dashboard
- Open your browser to https:///dashboard
- Log in with your credentials
- Monitor webhook status
- View webhook logs
Use quicky webhooks with these commands:
status- Check webhook server statusrestart- Restart the webhook serverstop- Stop the webhook serverlogs- View webhook server logsdashboard- Access the webhook dashboard
quicky upgradeUpgrades Quicky to the latest version.
quicky uninstallRemoves Quicky from your system.
This project is licensed under the MIT License - see the LICENSE file for details.
Feel free to reach out to me on π @alemalohe if you have any questions or feedback!
Contributions are welcome! Please read the CONTRIBUTING file for guidelines on how to get started.