DeployAja Extension

The official VS Code extension for DeployAja - Deploy your applications easily to the DeployAja platform directly from your editor.

User Flow in Using the Extension

Supported project types:
This extension currently supports deployment for the following project types:

• Static HTML
• Laravel
• Next.js
• SvelteKit

1. User performs Login or Sign Up (if they do not already have an account) via the DeployAja web platform.
2. User opens the HTML static project folder that they want to deploy as a live website.
3. User clicks Deploy This Project in the extension.
4. User waits for the deployment process and can monitor the deployment status via:
   • The extension panel in VS Code, or
   • The DeployAja web dashboard.
5. Once the process completes successfully, the project will be live and accessible through the assigned domain.

Deployment Status

During the process, the deployment will have one of the following statuses:

• PENDING
  The deployment request has been received and is waiting to be processed.

• DEPLOYING
  The project is currently being processed and published.

• RUNNING
  The deployment is successful and the website is live.

• FAILED
  The deployment failed. Users can view the error details via the extension or the dashboard.

Features

Quick Deployment

• Deploy YAML configuration files with a single command
• Right-click deployment from editor or file explorer
• Dry-run mode to validate configurations before deploying
• Real-time deployment status updates

Secure Authentication

• Browser-based login (Recommended) - Secure OAuth-style flow
• Manual token entry - For advanced users or CI/CD scenarios
• Automatic token validation on startup
• Persistent session management

Deployments Management

• Deployment Tree View - Visual sidebar showing all your deployments with status indicators
• Interactive deployment list - View, manage, and access your deployments
• One-click URL opening - Click any deployment to open its live URL
• Status indicators: Running (✓), Deploying (⟳), Failed (✕)
• Filter and search through deployments

Context-Aware Actions

• Deploy YAML files directly from editor context menu
• Deploy from file explorer with right-click
• Automatic YAML file detection
• Quick access via Command Palette

Status Bar Integration

• Real-time login status indicator
• Quick access to login/logout
• Visual feedback for authentication state

Application Packaging

• Zip workspace folders for deployment
• Smart file exclusion (node_modules, .git, etc.)
• Custom zip naming

Requirements

• VS Code version 1.60.0 or higher
• Active internet connection for API communication
• DeployAja account (sign up at https://deployaja.id)

Getting Started

1. Install the Extension

   • Search for "DeployAja" in VS Code Extensions
   • Click Install

2. Login to DeployAja

   • Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
   • Type DeployAja: Login
   • Choose login method:
     • Browser Login (Recommended) - Opens browser for secure authentication
     • Manual Token - Enter API token from dashboard

3. Deploy Your First Application

   • Open a YAML configuration file
   • Right-click in editor → "Deploy Current YAML"
   • Or use Command Palette → DeployAja: Deploy Application
   • Choose deployment type:
     • Real Deployment - Actually deploys your application
     • Dry Run - Validates configuration only

4. View Your Deployments

   • Click DeployAja icon in Activity Bar
   • Browse deployments in the sidebar
   • Click on any deployment to open its URL
   • Right-click for more options

Commands

Access these commands via Command Palette (Ctrl+Shift+P / Cmd+Shift+P):

• DeployAja: Login - Login to your DeployAja account
• DeployAja: Deploy Application - Deploy the current YAML file
• DeployAja: Deploy Current YAML - Deploy active YAML editor
• DeployAja: List Deployments - Show all your deployments
• DeployAja: Get Deployment - Fetch deployment configuration
• DeployAja: Zip Application - Create a zip file of your workspace

Views

DeployAja Sidebar

• Main View - Quick actions and welcome screen
• Deployments View - Tree view of all your deployments with:
  • Deployment name and status
  • Clickable URLs to open deployments
  • Real-time status indicators
  • Contextual actions

Known Issues

• Large workspace folders may take time to zip
• Token validation requires active internet connection

Release Notes

0.5.5

• SvelteKit & Next.js Database Validation - Check Prisma tables when deploying with database; show error if missing and auto-select the correct Dockerfile if available.

0.5.3

• Change SvelteKit Port Configuration - Updated the default port configuration for SvelteKit deployments
• Express.js Tech Stack Adjustment - Automatically adjust the technology stack configuration when the user selects Express.js
• Now you can select the database - Choose a database (MySQL/PostgreSQL) during deployment setup

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

• Extension Guidelines

Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

• Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
• Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
• Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy!