Skip to content

talanayush/QuickLaunch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QuickLaunch

Instantly take your code from repo to live — no hassle, just deploy.

QuickLaunch is a lightweight deployment platform that takes a GitHub repository URL (frontend-only projects), builds it, and gives you back a live URL instantly.

Behind the scenes, it clones the repo, runs the build, pushes the static output to Amazon S3, and serves it through a reverse proxy on your domain. Users can track the build process in real-time via Socket.IO logs.


✨ Features

  • 🔗 One-click deploy – Just provide your GitHub repo URL
  • 📦 Automatic build – Clones, installs, and builds your frontend project
  • ☁️ AWS-powered hosting – Static files uploaded to S3
  • 🐳 Containerized builds – Ephemeral Docker containers run inside ECS tasks
  • 🎯 Reverse proxy system – Access your app at
    • projectId.localhost:8000
    • slug.localhost:8000
  • 📡 Real-time build logs – Streamed with Socket.IO
  • Fast and isolated – Each project is handled in its own environment

🛠️ Architecture

        ┌────────────────────┐
        │   GitHub Repo       │
        │  (Frontend Code)    │
        └─────────┬──────────┘
                  │
                  ▼
       ┌───────────────────────┐
       │ QuickLaunch API        │
       │ (POST /project)        │
       └─────────┬─────────────┘
                  │
                  ▼
       ┌───────────────────────┐
       │ Build Runner (Docker) │
       │  • Clone Repo          │
       │  • Install + Build     │
       │  • Upload to S3        │
       └─────────┬─────────────┘
                  │
                  ▼
       ┌───────────────────────┐
       │ Amazon S3             │
       │ (Static Files Store)  │
       └─────────┬─────────────┘
                  │
                  ▼
       ┌───────────────────────┐
       │ Reverse Proxy          │
       │ (Nginx/Node)           │
       │ projectId.localhost    │
       │ slug.localhost         │
       └─────────┬─────────────┘
                  │
                  ▼
       ┌───────────────────────┐
       │   User’s Browser       │
       │  (index.html Served)   │
       └───────────────────────┘
  • Logs: Build process streamed in real-time via Socket.IO
  • ECS + ECR: Containers orchestrated inside ECS tasks, based on images stored in ECR

⚡ Quick Start (Local Dev)

Prerequisites

  • Node.js (v18+)
  • Docker installed & running
  • AWS CLI configured (aws configure)
  • An S3 bucket + ECR repo set up

1. Clone the repo

git clone https://github.com/your-username/quicklaunch.git
cd quicklaunch

Create a .env file:
AWS_REGION=ap-south-1
AWS_ACCESS_KEY_ID=your-key
AWS_SECRET_ACCESS_KEY=your-secret
S3_BUCKET=your-bucket
REDIS_URL=redis://localhost:6379

# Start API server
node index.js
#start Proxy Server
node index.js

🤝 Contributing

PRs and suggestions welcome! Please open an issue first to discuss major changes.

About

Instantly take your code from repo to live — no hassle, just deploy.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors