Skip to content
Klutch.sh Docs

Deploying a Maybe App

Introduction

Maybe is an open-source personal finance app built on Node.js/Next.js for budgeting, planning, and portfolio tracking. Deploying Maybe with a Dockerfile on Klutch.sh delivers reproducible builds, managed secrets, and persistent storage for exports and uploads—all configured from klutch.sh/app. This guide covers installation, repository prep, a production-ready Dockerfile, deployment steps, Nixpacks overrides, sample API usage, and production best practices.

Prerequisites

  • A Klutch.sh account (sign up)
  • A GitHub repository containing your Maybe code and Dockerfile (GitHub is the only supported git source)
  • Database credentials if you run Maybe with Postgres (recommended) or SQLite
  • Optional object storage for exports and attachments

For onboarding, see the Quick Start.

Architecture and ports

  • Maybe runs as an HTTP app; set the internal container port to 3000.
  • If you deploy Postgres separately, run it as a Klutch.sh TCP app exposed on port 8000 and connect on 5432.
  • Persistent storage is recommended for user exports/backups and logs.

Repository layout

maybe/
├── Dockerfile              # Must be at repo root for auto-detection
├── package.json
├── pnpm-lock.yaml          # or yarn.lock / package-lock.json
├── .env.example            # Template only; no secrets
├── public/                 # Static assets
├── uploads/                # Exports/attachments (persist)
└── README.md

Keep secrets out of Git; store them in Klutch.sh environment variables.

Installation (local) and starter commands

Install dependencies and run locally before pushing to GitHub:

Terminal window
pnpm install
pnpm build
pnpm start -- --port 3000

Optional helper start.sh for portability and Nixpacks fallback:

#!/usr/bin/env bash
set -euo pipefail
exec pnpm start -- --port "${PORT:-3000}"

Make it executable with chmod +x start.sh.

Dockerfile for Maybe (production-ready)

Place this Dockerfile at the repo root; Klutch.sh auto-detects it (no Docker selection in the UI):

FROM node:18-alpine AS build
WORKDIR /app


COPY package.json pnpm-lock.yaml* yarn.lock* package-lock.json* ./
RUN corepack enable
RUN pnpm install --frozen-lockfile


COPY . .
RUN pnpm build


FROM node:18-alpine
WORKDIR /app
ENV NODE_ENV=production PORT=3000


COPY --from=build /app /app
RUN corepack enable && pnpm install --prod --frozen-lockfile


EXPOSE 3000
CMD ["pnpm", "start", "--", "--port", "3000"]

Notes:

  • Add build tools (apk add --no-cache python3 make g++) in the build stage if native modules are required.
  • Keep uploads/ writable and mount it as a volume for exports and attachments.

Environment variables (Klutch.sh)

Set these in Klutch.sh before deploying:

  • NODE_ENV=production
  • PORT=3000
  • APP_BASE_URL=https://example-app.klutch.sh
  • DATABASE_URL=postgres://<user>:<password>@<host>:5432/<db> (if using Postgres)
  • UPLOAD_DIR=/app/uploads
  • Any provider/API keys your Maybe setup needs

If you deploy without the Dockerfile and need Nixpacks overrides:

  • NIXPACKS_BUILD_CMD=pnpm install --frozen-lockfile && pnpm build
  • NIXPACKS_START_CMD=pnpm start -- --port 3000
  • NIXPACKS_NODE_VERSION=18

Attach persistent volumes

In Klutch.sh storage settings, add mount paths and sizes (no names required):

  • /app/uploads — user exports, attachments, backups.
  • /app/logs — optional if you store logs locally.

Ensure these paths are writable inside the container.

Deploy Maybe on Klutch.sh (Dockerfile workflow)

  1. Push your repository—with the Dockerfile at the root—to GitHub.
  2. Open klutch.sh/app, create a project, and add an app.
  3. Select HTTP traffic and set the internal port to 3000.
  4. Add the environment variables above (database URL if used, app URL, upload dir, provider keys, and any NIXPACKS_* overrides if you temporarily deploy without the Dockerfile).
  5. Attach persistent volumes for /app/uploads (and /app/logs if used), selecting sizes that fit your storage needs.
  6. Deploy. Your Maybe instance will be reachable at https://example-app.klutch.sh; attach a custom domain if desired.

Sample API usage

Fetch accounts (example endpoint; adjust to your API):

Terminal window
curl -X GET "https://example-app.klutch.sh/api/accounts" \
  -H "Authorization: Bearer <token>"

Health checks and production tips

  • Add a health endpoint (e.g., /api/health) and probe it for readiness.
  • Enforce HTTPS at the edge; forward HTTP to port 3000 internally.
  • Keep lockfiles and Node version pinned; test upgrades in staging.
  • Monitor storage usage on /app/uploads and resize before it fills.
  • Secure provider/API keys in Klutch.sh secrets and rotate regularly.

Maybe on Klutch.sh combines reproducible Docker builds with managed secrets, persistent storage, and flexible HTTP/TCP routing. With the Dockerfile at the repo root, port 3000 configured, and your database connected, you can deliver reliable personal finance tooling without extra YAML or workflow overhead.