Skip to content
Klutch.sh Docs

Deploying an Aurelia App

Aurelia is a modern, open-source front-end framework for building browser-based applications. It features a powerful data-binding engine, modular architecture, and a focus on web standards, making it ideal for scalable and maintainable single-page applications (SPAs).

This guide explains how to deploy an Aurelia application to Klutch.sh, both with and without a Dockerfile. It covers installation, sample code, and deployment steps.

Prerequisites

  • Node.js & npm installed (Download)
  • Git and GitHub account
  • Klutch.sh account

Getting Started: Create an Aurelia App

  1. Install Aurelia CLI globally:
    Terminal window
    npm install -g aurelia-cli
  2. Create a new Aurelia app:
    Terminal window
    au new my-aurelia-app
    cd my-aurelia-app
    npm install
  3. Start the development server:
    Terminal window
    au run --watch
    Your app should be running at http://localhost:8080.

Sample Code (src/app.html & src/app.js)

Replace the contents of src/app.html with:

<template>
  <h1>Hello from Aurelia on Klutch.sh!</h1>
</template>

Replace the contents of src/app.js with:

export class App {}

Deploying Without a Dockerfile

Aurelia apps are static sites after build. Klutch.sh can deploy static sites directly.

  1. Push your Aurelia app to a GitHub repository.
  2. Log in to Klutch.sh.
  3. Create a new project.
  4. Create a new app:
    • Select your Aurelia GitHub repository and branch
    • Choose “Static Site” as the app type
    • Set build command: au build --env prod
    • Set output directory: dist
    • Configure region, compute, and environment variables as needed
  5. Click “Create” to deploy. Klutch.sh will build and serve your static Aurelia app.

Deploying With a Dockerfile

If you need custom server logic or want to use a Dockerfile:

  1. Add a Dockerfile to your project root. Example: 
    # Build stage
    FROM node:20-alpine AS builder
    WORKDIR /app
    COPY package*.json ./
    RUN npm install -g aurelia-cli && npm install
    COPY . .
    RUN au build --env prod
    

    # Production stage
    FROM nginx:alpine
    COPY --from=builder /app/dist /usr/share/nginx/html
    EXPOSE 80
    CMD ["nginx", "-g", "daemon off;"]
  2. Push your code (with Dockerfile) to GitHub.
  3. In Klutch.sh, create a new app and select the Dockerfile option when prompted.
  4. Set service details and environment variables as needed.
  5. Click “Create” to deploy. Klutch.sh will build your Docker image and serve your Aurelia app via Nginx.

Resources

Deploying Aurelia to Klutch.sh is fast and flexible. Use static site deployment for most cases, or Dockerfile for custom setups.