create-snagset 0.0.2 → 0.0.4

package/README.md

@@ -4,14 +4,27 @@ Scaffold a self-hosted **[Snagset](https://github.com/snagset/snagset)** instanc
 — click-to-comment review for your clients' live sites.
 
 ```bash
-npx create-snagset my-review
+pnpm create snagset my-review
 cd my-review
-docker compose up
+pnpm install && pnpm start
 ```
 
-Postgres is included. Open `http://localhost:8080` and follow the claim URL in
-the logs. Already have a database? Put its URL in `.env`, then `npm install &&
-npm start`.
+<details>
+<summary>npm · yarn · bun</summary>
+
+```bash
+npm  create snagset@latest my-review   # then: npm install  && npm start
+yarn create snagset my-review          # then: yarn install && yarn start
+bun  create snagset my-review          # then: bun install  && bun start
+```
+</details>
+
+Bring a Postgres URL — a free Neon or Supabase branch, or a local install — and
+put it in `.env` as `DATABASE_URL`. Open `http://localhost:8080` and follow the
+claim URL in the logs.
+
+**No Docker, on purpose.** No Dockerfile, no compose file, nothing to build:
+Snagset is a Node process and a Postgres URL.
 
 ## What you get
 
@@ -19,7 +32,6 @@ A directory with everything an instance needs and nothing it does not:
 
 | | |
 |---|---|
-| `compose.yml` | The server and a Postgres, for `docker compose up` |
 | `.env` | Configuration. **`DATABASE_URL` is the only required variable** — a signing key is generated into it for you |
 | `package.json` | `@snagset/server` as a dependency, with `start`, `migrate` and `env` scripts |
 | `vercel.json` + `api/index.js` | Deploy to Vercel instead, if you would rather not run anything |

package/dist/index.js

@@ -7,9 +7,9 @@ import { scaffold } from "./scaffold.js";
  */
 const target = process.argv[2];
 if (!target || target.startsWith("-")) {
-    process.stderr.write("usage: npx create-snagset <directory>\n\n" +
-        "  npx create-snagset my-review\n" +
-        "  cd my-review && docker compose up\n");
+    process.stderr.write("usage: create-snagset <directory>\n\n" +
+        "  pnpm create snagset my-review\n" +
+        "  cd my-review && pnpm install && pnpm start\n");
     process.exit(2);
 }
 try {
@@ -21,9 +21,11 @@ catch (e) {
 }
 const name = target.split("/").pop() || "snagset";
 process.stdout.write(`\n  ✓ ${name}\n\n` +
+    `  1. Put a Postgres URL in .env as DATABASE_URL.\n` +
+    `     A free Neon or Supabase branch works, so does a local install.\n\n` +
     `  cd ${target}\n` +
-    `  docker compose up\n\n` +
-    `  Then open http://localhost:8080 and follow the claim URL in the logs.\n` +
-    `  No Docker? Put a Postgres URL in .env, then \`npm install && npm start\`.\n\n` +
+    `  pnpm install && pnpm start\n\n` +
+    `  (npm, yarn and bun work the same way.)\n\n` +
+    `  Then open http://localhost:8080 and follow the claim URL in the logs.\n\n` +
     `  A signing key was generated into .env. Back it up — without it every\n` +
     `  session and stored credential is unrecoverable.\n\n`);

package/dist/template/README.md

@@ -5,19 +5,32 @@ review for your clients' live sites.
 
 ## Run it
 
+You need a Postgres and its connection string. A free
+[Neon](https://neon.tech) or [Supabase](https://supabase.com) branch takes a
+minute and works from anywhere; a local `postgres` install is just as good.
+
+Put the URL in `.env` as `DATABASE_URL`, then:
+
 ```bash
-docker compose up
+pnpm install
+pnpm start
 ```
 
-Postgres is included. Open http://localhost:8080 and follow the claim URL
-printed in the logs.
-
-**Already have a database?** Put its URL in `.env`, then:
+<details>
+<summary>npm · yarn · bun</summary>
 
 ```bash
-npm install
-npm start
+npm install && npm start
+yarn install && yarn start
+bun install && bun start
 ```
+</details>
+
+Open http://localhost:8080 and follow the claim URL printed in the logs.
+
+**No Docker anywhere in this project, deliberately.** One less thing to
+install, and one less thing between you and a database you can also reach from
+your laptop, your CI and your deploy.
 
 ## Add a site
 
@@ -28,7 +41,7 @@ Sign in, open **Sites**, and add one. You get a script tag:
 ```
 
 Paste it into the site you want reviewed, before `</body>`. Or install the npm
-package — `npm i snagset` — and `snagset.init({ host, site })`, or one of the
+package — `pnpm add snagset` — and `snagset.init({ host, site })`, or one of the
 framework subpaths: `snagset/react`, `snagset/vue`, `snagset/next`,
 `snagset/vite` (which also covers Nuxt and SvelteKit), `snagset/astro`. They
 all write the same tag.
@@ -42,8 +55,8 @@ ignored, which is the hardest failure here to spot from the outside.
 `.env`. Only `DATABASE_URL` is required.
 
 ```bash
-npm run env          # every variable this build accepts, with its default
-npm run env MAIL     # just the ones matching MAIL
+pnpm env             # every variable this build accepts, with its default
+pnpm env MAIL        # just the ones matching MAIL
 ```
 
 Screenshots need an S3-compatible bucket (R2, Spaces, MinIO, AWS).
@@ -63,13 +76,13 @@ nothing would decrypt), and add a release command:
 npx snagset migrate
 ```
 
-**Anything that runs Node.** `npm start`. It serves the API, the dashboard and
+**Anything that runs Node.** `pnpm start`. It serves the API, the dashboard and
 the widget on one port.
 
 ## Upgrading
 
 ```bash
-npm update @snagset/server
+pnpm update @snagset/server
 ```
 
 Migrations run on boot. There is no build step to redo.

package/dist/template/_env.example

@@ -1,5 +1,6 @@
 # ── Required ───────────────────────────────────────────────────────────
-# Any Postgres 14+. `docker compose up` provides one at this URL.
+# Any Postgres 14+ — a free Neon or Supabase branch, or a local install.
+# Use the POOLED connection string where your provider offers one.
 DATABASE_URL=postgres://snagset:snagset@localhost:5432/snagset
 
 # ── Strongly recommended ───────────────────────────────────────────────

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-snagset",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "private": false,
   "type": "module",
   "description": "Scaffold your own Snagset instance. One command, Postgres included, one variable to fill in.",

package/dist/template/compose.yml

@@ -1,40 +0,0 @@
-# One command: `docker compose up`.
-#
-# Postgres is included so there is nothing to provision before the first run.
-# Point DATABASE_URL at a managed database instead — Neon, Supabase, RDS — and
-# delete the `db` service; nothing else changes.
-services:
-  db:
-    image: postgres:18-alpine
-    environment:
-      POSTGRES_USER: snagset
-      POSTGRES_PASSWORD: snagset
-      POSTGRES_DB: snagset
-    ports: ["5432:5432"]
-    volumes: ["snagset-db:/var/lib/postgresql/data"]
-    healthcheck:
-      # The server migrates on boot, so it must not start against a database
-      # that is still initialising — the advisory lock would be taken against
-      # a socket that is not accepting connections yet.
-      test: ["CMD-SHELL", "pg_isready -U snagset"]
-      interval: 2s
-      timeout: 3s
-      retries: 20
-
-  snagset:
-    image: node:22-alpine
-    working_dir: /app
-    volumes: ["./:/app"]
-    command: sh -c "npm install --omit=dev && npm start"
-    env_file: [.env]
-    environment:
-      # Inside the compose network the database is `db`, not `localhost` —
-      # overridden here so the same .env works for `npm start` on the host.
-      DATABASE_URL: postgres://snagset:snagset@db:5432/snagset
-      SNAGSET_BIND_ADDRESS: 0.0.0.0
-    ports: ["8080:8080"]
-    depends_on:
-      db: { condition: service_healthy }
-
-volumes:
-  snagset-db: