Deploying a SvelteKit App

SvelteKit is a modern framework for building high-performance web applications with Svelte. It offers file-based routing, server-side rendering, static site generation, and a flexible adapter system, making it ideal for building fast, scalable, and maintainable web projects.

This guide explains how to deploy a SvelteKit application to Klutch.sh, both with and without a Dockerfile. It also covers installation and provides sample code to get started.

Prerequisites

• Node.js 18+
• Git and GitHub account
• Klutch.sh account

---

Getting Started: Install SvelteKit

1. Create a new SvelteKit app:

   npm create svelte@latest my-sveltekit-app
   cd my-sveltekit-app
   npm install

2. Start the development server:

   npm run dev

   Your app should be running at http://localhost:5173 or http://localhost:3000.

Sample Code (src/routes/+page.svelte)

Add a simple page to your SvelteKit project:

<script>
  // No script needed for this simple example
</script>

<h1>Hello from SvelteKit on Klutch.sh!</h1>
<p>This is your starter page.</p>

---

Deploying Without a Dockerfile

1. Push your SvelteKit app to a GitHub repository.
2. Log in to Klutch.sh.
3. Create a new project and give it a name.
4. Create a new app:
   • Select your SvelteKit GitHub repository and branch
   • Set the port to route traffic (usually 3000 for SvelteKit)
   • Choose region, compute, number of instances, and add any environment variables
5. Add a start script in your package.json:

   "scripts": {
     "start": "svelte-kit start"
   }

6. Make sure your server listens on the port provided by Klutch.sh via the PORT environment variable:

   const port = process.env.PORT || 3000;
   app.listen(port, () => {
     console.log(`Server running on port ${port}`);
   });

   (If using a custom server. SvelteKit’s default adapter will handle this automatically.)
7. Click “Create” to deploy. Klutch.sh will build and deploy your app automatically.

---

Deploying With a Dockerfile

1. Add a Dockerfile to your project root. Example:

   # Use official Node.js image
   FROM node:18-alpine
   
   # Set working directory
   WORKDIR /app
   
   # Copy package files and install dependencies
   COPY package*.json ./
   RUN npm install --production
   
   # Copy app source
   COPY . .
   
   # Build SvelteKit app
   RUN npm run build
   
   # Expose port (match your SvelteKit app)
   EXPOSE 3000
   
   # Start the app
   CMD ["npm", "start"]

2. Push your code (with Dockerfile) to GitHub.
3. In Klutch.sh, follow the same steps to create a project and app, but select the Dockerfile option when prompted.
4. Set the service details and environment variables as needed.
5. Click “Create” to deploy. Klutch.sh will build your Docker image and deploy your app.

Note: Your SvelteKit app should always listen on the PORT environment variable as shown above if using a custom server.

---

Resources

• Klutch.sh Documentation
• SvelteKit Documentation

---

Deploying to Klutch.sh is simple and flexible. Choose the method that best fits your workflow and project requirements.