Automatic database setup + docker

.gitignore

@@ -1,3 +1,4 @@
 node_modules
+coverage
 dist
 .env

compose.yaml

@@ -0,0 +1,37 @@
+version: "3.9"
+
+services:
+  postgres:
+    image: postgres:alpine
+    ports:
+      - 5432:5432
+    environment:
+      - POSTGRES_PASSWORD=test
+      - POSTGRES_USER=postgres
+      - POSTGRES_DB=postgres
+    networks:
+      - common-net
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+
+  server:
+    build: .
+    depends_on:
+      postgres:
+        condition: service_healthy
+    ports:
+      - "8000:5000"
+    environment:
+      - PGPASSWORD=test
+      - PGDATABASE=postgres
+      - PGUSER=postgres
+      - PGHOST=postgres
+      - PGPORT=5432
+    networks:
+      - common-net
+
+networks:
+  common-net: {}

dockerfile

@@ -0,0 +1,40 @@
+FROM node:18-alpine AS base
+
+FROM base AS deps
+
+RUN apk add --no-cache libc6-compat
+
+WORKDIR /app
+
+COPY package.json package-lock.json* ./
+COPY npubcash-website/package.json npubcash-website/package-lock.json* ./npubcash-website/
+
+RUN npm ci
+
+FROM base AS builder
+WORKDIR /app
+COPY --from=deps /app/node_modules ./node_modules
+COPY . .
+
+RUN npm run build
+
+FROM base AS runner
+WORKDIR /app
+
+ENV NODE_ENV production
+
+RUN addgroup --system --gid 1001 nodejs
+RUN adduser --system --uid 1001 npc
+
+COPY --from=builder --chown=npc:nodejs /app/dist ./dist
+COPY --from=builder --chown=npc:nodejs /app/npubcash-website/dist ./npubcash-website/dist
+COPY --from=builder --chown=npc:nodejs /app/migrations ./migrations
+
+USER npc
+
+EXPOSE 8000
+
+ENV PORT 8000 
+
+
+CMD node dist/index.js

docs/deploy.md

@@ -0,0 +1,79 @@
+# Deploy npub.cash
+
+## Prerequisites
+
+In order to deploy npub.cash yourself you will need:
+
+- A postgres database to connect to
+- A Blink API account
+
+## Deploy npubcash-server
+
+Deploying npubcash-server is easy. There are two ways to deploy the app:
+
+### Docker
+
+npub.cash ships with a dockerfile. Clone the repository, build the image and deploy it.
+
+```sh
+git clone -b migrations --recurse-submodules https://github.com/cashubtc/npubcash-server.git
+
+cd npubcash-server
+
+docker build -t npc-server .
+```
+
+Once deployed make sure to set your environment variables accordingly (see below)
+
+### Manually
+
+You can also build the application code yourself and deploy it Manually
+
+```sh
+git clone -b migrations --recurse-submodules https://github.com/cashubtc/npubcash-server.git
+
+cd npubcash-server
+
+npm ci
+
+npm run build
+```
+
+Once deployed you can start the service using `npm run start`. Make sure to set your environment variables accordingly (see below)
+
+### Env variables
+
+npubcash-server needs a couple of environment variables to run.
+
+```sh
+#Your database connection settings
+PGUSER=
+PGPASSWORD=
+PGHOST=
+PGDATABASE=
+PGPORT=
+# The url of the default mint
+MINTURL=
+# You Blink API settings
+BLINK_API_KEY=
+BLINK_WALLET_ID=
+BLINK_URL=
+# The nostr private key used by the NIP-57 provider
+ZAP_SECRET_KEY=
+# LNURL settings
+LNURL_MIN_AMOUNT=
+LNURL_MAX_AMOUNT=
+# The hostname your app will be reached under
+HOSTNAME=
+```
+
+## Setup Blink
+
+Right now there is no way for a mint to let you know once an invoice has been paid (until websockets are merged soon(tm)).
+Therefore npubcash-server uses Blink as a wrapper. You need to configure your Blink API credentials in your environment and then add your servers webhook url to Blink.
+Open the Blink Callback [Dashboard](https://dashboard.blink.sv/callback) and add your webhook url. It will be `https://<your hostname>/api/v1/paid`
+
+## Setup locally
+
+It is possible to quickly setup npubcash-server locally for development using the `compose.yaml` file.
+However as the service relies on Blinks webhook integration, you will need to have the machine running the server reachable publicly and add its IP to the Blink dashboard