Skip to content

Deploying an ExpressJS App

ExpressJS is a fast, unopinionated, and minimalist web framework for Node.js, widely used for building APIs and web applications. It provides a robust set of features for web and mobile applications, making it a popular choice for developers who want flexibility and simplicity.

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

Prerequisites

  • Node.js and npm installed
  • Git and GitHub account
  • Klutch.sh account

Getting Started: Install ExpressJS

  1. Create a new directory for your app and initialize npm:
    Terminal window
    mkdir my-express-app
    cd my-express-app
    npm init -y
  2. Install ExpressJS:
    Terminal window
    npm install express
  3. Create a basic ExpressJS server (index.js):
    const express = require('express');
    const app = express();
    const port = process.env.PORT || 3000;
    app.get('/', (req, res) => {
    res.send('Hello from ExpressJS on Klutch.sh!');
    });
    app.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:
    Terminal window
    npm start
    Visit http://localhost:3000 to see your app running.

Deploying Without a Dockerfile

  1. Push your ExpressJS 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 ExpressJS GitHub repository and branch
    • Set the port to route traffic (usually 3000 for ExpressJS)
    • Choose region, compute, number of instances, and add any environment variables
  5. 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 ExpressJS 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 ExpressJS app should always listen on the PORT environment variable as shown above.


Resources


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