A CLI tool that streamlines the deployment and management of self-hosted Next.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 Next.js apps on remote servers.
- π GitHub Integration: Initialize, deploy, and manage Next.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.
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 npm
Install Quicky globally using either npx or npm:
npx quicky@latest install
or
sudo npm install -g quicky
Note: The sudo command is necessary for global installation and to prevent permission issues when configuring domains.
quicky init
This 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 deploy
This command will prompt you to provide:
- Your GitHub username or any organization name
- The repository name
- The port number on which the project should run (e.g., 3000)
Environment Variables - During deployment, you'll be asked whether you'd like to add environment variables to your project.
quicky manage
Lists 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 list
Displays 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 domains
This command allows you to effortlessly add and remove domains and subdomains for your projects.
quicky webhooks
This command allows you to manage the webhook server for your projects. You can restart the webhook server, check its status, stop it, or show logs.
quicky upgrade
Upgrades Quicky to the latest version.
quicky uninstall
Removes 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 X @alemalohe if you have any questions or feedback!
Contributions are welcome! Please read the CONTRIBUTING file for guidelines on how to get started.