Deploying an ElysiaJS App

ElysiaJS is a fast, modern, and lightweight web framework for Node.js, designed for building scalable APIs and web applications with minimal overhead. It features a simple API, TypeScript support, and a focus on performance, making it ideal for both small projects and large-scale services.

This guide explains how to deploy an ElysiaJS 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 ElysiaJS

1. Create a new directory for your app and initialize npm:

   mkdir my-elysia-app
   cd my-elysia-app
   npm init -y

2. Install ElysiaJS:

   npm install elysia

3. Create a basic ElysiaJS app (index.js):

   import { Elysia } from 'elysia';
   
   const port = process.env.PORT || 3000;
   
   new Elysia()
     .get('/', () => 'Hello from ElysiaJS on Klutch.sh!')
     .listen(port);
   
   console.log(`Server running on port ${port}`);

4. Add a start script in your package.json:

   "scripts": {
     "start": "node index.js"
   }

5. Test locally:

   npm start

   Visit http://localhost:3000 to see your app running.

---

Deploying Without a Dockerfile

1. Push your ElysiaJS 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 ElysiaJS GitHub repository and branch
   • Set the port to route traffic (usually 3000 for ElysiaJS)
   • Choose region, compute, number of instances, and add any environment variables
5. Add a start script in your package.json as shown above.
6. 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 . .
   
   # Expose port (match your ElysiaJS 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 ElysiaJS app should always listen on the PORT environment variable as shown above.

---

Resources

• Klutch.sh Documentation
• ElysiaJS Documentation

---

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