How It Works

Learn how to create, manage, and deploy your static websites with Quick Deploy

Getting Started

Quick Deploy makes it easy to host and manage your static websites. You have two options to get started:

Web Dashboard

Upload your files directly through the browser interface. Perfect for quick updates and managing multiple sites.

Quick CLI

Deploy from your terminal with simple commands. Ideal for automation and integrating into your development workflow.

Step-by-Step Process

1

Create Your Website

Start by creating a new website through the dashboard. Choose a unique path (URL) for your site and give it a memorable name.

Example:
Name: My Portfolio
Path: portfolio
Your site will be accessible at: /portfolio
2

Upload Your Files

Upload your HTML, CSS, JavaScript, images, and other static assets. Your site must include an index.html file as the entry point.

Supported file types: HTML, CSS, JS, JSON, images (PNG, JPG, GIF, SVG, ICO), fonts (WOFF, WOFF2, TTF, EOT)
3

Deploy & Manage

Once uploaded, your website is live immediately! You can:

  • View deployment history and track changes
  • Monitor analytics and visitor statistics
  • Update files anytime by uploading new versions
  • Protect your site with password authentication (optional)

Using the Quick CLI

For developers who prefer working from the terminal, the Quick CLI provides powerful commands to manage your websites programmatically.

Initialize a new project

$ quick init

Configure your credentials

$ quick login

Deploy your website

$ quick deploy
API Keys Required: To use the CLI, you'll need to create an API key from the API Keys page.

API Access

Integrate Quick Deploy into your existing tools and workflows using our RESTful API. Perfect for CI/CD pipelines, automated deployments, and custom integrations.

/api/v1
Current API version
REST
Standard HTTP methods
JSON
Response format

Example: List your websites

curl -H "Authorization: Bearer YOUR_API_KEY" \
https://your-domain.com/api/v1/websites

Visit the API Keys page to generate your API key and start building.

Download Starter Files

Get started quickly without installing the CLI

What's Included:

index.html

Responsive HTML template with Tailwind CSS

main.css

Custom styles with CSS variables and animations

application.js

JavaScript helpers for forms and API calls

AGENTS.md

Complete documentation and best practices

Download Starter Files

ZIP file includes all 4 files ready to customize and deploy

Quick Start Instructions:

  1. 1. Download and extract the ZIP file
  2. 2. Customize the HTML, CSS, and JavaScript files to match your needs
  3. 3. Create a new website from the Websites page
  4. 4. Upload your customized files to your new website
  5. 5. Your website is now live!

Need Help?

If you have questions or run into any issues, we're here to help!