KamuiDash KamuiDash Docs
EN JA

Quick Start

This guide walks you through deploying your first application on KamuiDash.

Prerequisites

  • A GitHub account
  • A GitHub repository with your code

Step 1: Create Account / Login

  1. Go to KamuiDash
  2. Click "Login with GitHub"
  3. Authorize GitHub access
  4. Register and verify your email address

Step 2: Create a Project

A project is a container for grouping applications and databases.

Using GUI

  1. Click "New Project" in the dashboard
  2. Enter a project name
  3. Select a plan (Free or Pro)
  4. Select a region (Tokyo)
  5. Click "Create"

Using CLI

kamui projects create

Follow the interactive prompts to enter name, plan, and region.

Step 3: Install GitHub App

To deploy from a GitHub repository, you need to install the GitHub App.

  1. Select "GitHub Repository" when creating an app
  2. Click "Install GitHub App"
  3. Select the Organization or account to install
  4. Choose which repositories to grant access

Step 4: Create an Application

Web Server

Deploy server-side applications using Node.js, Go, or Python.

Using GUI

  1. Open a project and click "New App" → "Web Server"
  2. Configure settings:
    • App name
    • Language (Node.js / Go / Python)
    • Select repository and branch
    • Setup command (e.g., npm install)
    • Pre-build command (e.g., npm run migrate)
    • Application start command (e.g., npm start)
    • Health check endpoint (e.g., /health)
  3. Click "Create"

Using CLI

kamui apps create

Follow the interactive prompts.

Web Page

Deploy static sites consisting of HTML, CSS, and JavaScript only.

From GitHub Repository

  1. Select "New App" → "Web Page" → "GitHub"
  2. Select repository and branch
  3. Specify the public directory (e.g., dist, build)
  4. Click "Create"

Step 5: Verify Deployment

After creating an app, the build and deploy process starts automatically.

  1. Check the status in the app detail screen
  2. Once it shows "running", access the provided URL
  3. Verify your application is working correctly

Subsequent Deployments

Simply push to your GitHub repository to trigger automatic redeployment.

git add .
git commit -m "Update feature"
git push origin main

To manually redeploy, click the "Redeploy" button in the app detail screen on the dashboard.

Next Steps