Skip to content

Deploying a Fastify App

Fastify is a highly performant, low-overhead web framework for Node.js, designed for building fast and scalable APIs. It features a powerful plugin architecture, built-in schema validation, and a focus on developer experience, making it a great choice for modern backend applications.

This guide explains how to deploy a Fastify 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 Fastify

  1. Create a new directory for your app and initialize npm:
    Terminal window
    mkdir my-fastify-app
    cd my-fastify-app
    npm init -y
  2. Install Fastify:
    Terminal window
    npm install fastify
  3. Create a basic Fastify app (index.js):
    const fastify = require('fastify')();
    const port = process.env.PORT || 3000;
    fastify.get('/', async (request, reply) => {
    return 'Hello from Fastify on Klutch.sh!';
    });
    fastify.listen({ port, host: '0.0.0.0' }, (err, address) => {
    if (err) throw err;
    console.log(`Server running on ${address}`);
    });
  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 Fastify 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 Fastify GitHub repository and branch
    • Set the port to route traffic (usually 3000 for Fastify)
    • 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 Fastify 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 Fastify 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.