Skip to main content

🏠 Deploy a Generated App Locally

Once you've generated an app using the Quome App Builder, you may want to download, deploy, and test it locally. This guide will walk you through the process of downloading and deploying your generated app on your local machine.

🔄 Local Deployment Workflow​

📥 Step 1: Download Your Generated App and Extract it Locally​

📋 Steps:

  1. 🖱️ Click the "Download" button in the App Builder interface
  2. 💾 Save the tar.gz file containing all of your app's files to your local machine
  3. 📦 Extract the tar.gz file in the directory where you want your app files to be located

🐳 Step 2: Deploy and Test Locally Using Docker​

🚀 Quick Start: Follow the instructions in the app/README.md file to deploy and test your app locally using Docker. Your generated app includes all necessary Docker configuration files!

😸 Step 3: Create a Repository on GitHub (highly recommended)​

Option 1: Using the Command Line​

  1. Create a new repository on GitHub:

    If you have the GitHub CLI installed:

    gh repo create your-repo-name --private  # or --public

    Otherwise:

    • Go to GitHub.com
    • Click the "+" icon and select "New repository"
    • Name your repository (e.g., "my-quome-app")
    • Keep it public or private as desired
    • Do not initialize with README (one is already included with your downloaded files)
    • Click "Create repository"

  2. Clone the empty repository to your local machine:

    git clone https://github.com/yourusername/your-repo-name.git
    cd your-repo-name

  3. Copy your extracted app files into the cloned repository directory, then commit and push:

    # Copy all files from your extracted app directory to this directory
    # Then add, commit, and push
    git add .
    git commit -m "Initial commit: Quome generated app"
    git push

Option 2: Using the Web Interface​

  1. Create a new repository on GitHub:

    • Go to GitHub.com and sign in to your account
    • Navigate to your Repositories
    • Click the "New" button to create a new repository
    • Name your repository (e.g., "my-quome-app")
    • Keep it public or private as desired
    • Do not initialize with README (one is already included with your downloaded files)
    • Click "Create repository"

  2. Upload your files using GitHub's web interface:

    • On your new repository page, click "uploading an existing file"
    • Drag and drop all the files from your extracted app directory
    • Add a commit message like "Initial commit: Quome generated app"
    • Click "Commit changes"

  3. Clone the repository to your local machine for development:

    In the command line, navigate to where you want to work on your app and run:

    git clone https://github.com/yourusername/your-repo-name.git
    cd your-repo-name