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
- Create a new directory for your app and initialize npm:
Terminal window mkdir my-express-appcd my-express-appnpm init -y - Install ExpressJS:
Terminal window npm install express - 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}`);}); - Add a start script in your
package.json
:"scripts": {"start": "node index.js"} - Test locally:
Visit http://localhost:3000 to see your app running.
Terminal window npm start
Deploying Without a Dockerfile
- Push your ExpressJS app to a GitHub repository.
- Log in to Klutch.sh.
- Create a new project and give it a name.
- 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
- Click “Create” to deploy. Klutch.sh will build and deploy your app automatically.
Deploying With a Dockerfile
- Add a
Dockerfile
to your project root. Example:# Use official Node.js imageFROM node:18-alpine# Set working directoryWORKDIR /app# Copy package files and install dependenciesCOPY package*.json ./RUN npm install --production# Copy app sourceCOPY . .# Expose port (match your ExpressJS app)EXPOSE 3000# Start the appCMD ["npm", "start"] - Push your code (with Dockerfile) to GitHub.
- In Klutch.sh, follow the same steps to create a project and app, but select the Dockerfile option when prompted.
- Set the service details and environment variables as needed.
- 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.