Deploying a NextJS App

NextJS is a leading React framework for building fast, scalable, and production-ready web applications. It offers hybrid static and server rendering, API routes, file-based routing, and a rich plugin ecosystem, making it a top choice for modern web development.

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

1. Create a new NextJS app:

   npx create-next-app my-next-app
   cd my-next-app

2. Start the development server:

   npm run dev

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

Sample Code (pages/index.js)

export default function Home() {
  return (
    <main>
      <h1>Welcome to NextJS on Klutch.sh!</h1>
      <p>This is your starter page.</p>
    </main>
  );
}

---

Deploying Without a Dockerfile

1. Push your NextJS 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 NextJS GitHub repository and branch
   • Set the port to route traffic (usually 3000 for NextJS)
   • Choose region, compute, number of instances, and add any environment variables
5. Add a start script in your package.json:

   "scripts": {
     "start": "next start"
   }

6. If you use a custom server, make sure it 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}`);
   });

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 NextJS app
   RUN npm run build
   
   # Expose port (match your NextJS 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: If you use a custom server, ensure it listens on the PORT environment variable as shown above.

---

Resources

• Klutch.sh Documentation
• NextJS Documentation

---

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