Deploying a Remix App

Remix is a modern React framework focused on fast, dynamic, and resilient web applications. It offers nested routing, data loading APIs, and a strong emphasis on web standards, making it ideal for building scalable, production-grade apps with a great developer experience.

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

1. Create a new Remix app:

   npx create-remix@latest
   # Follow the prompts (choose TypeScript or JavaScript, deployment target, etc.)
   cd my-remix-app
   npm install

2. Start the development server:

   npm run dev

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

Sample Code (app/routes/index.tsx or app/routes/index.jsx)

Add a simple route to your Remix project:

export default function Index() {
  return (
    <div>
      <h1>Hello from Remix on Klutch.sh!</h1>
      <p>This is your starter page.</p>
    </div>
  );
}

---

Deploying Without a Dockerfile

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

   "scripts": {
     "start": "remix-serve build"
   }

   Or, if using Express as the server:

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

6. Make sure your server 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 Remix app
   RUN npm run build
   
   # Expose port (match your Remix 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 Remix app should always listen on the PORT environment variable as shown above.

---

Resources

• Klutch.sh Documentation
• Remix Documentation

---

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