moracarta 2.1.0 → 2.1.2

package/README.md

@@ -1,6 +1,9 @@
 # Moracarta
 
-**Create your own personalized love-letter website and deploy it completely for free.**
+**Create your own personalized love-letter website and deploy it completely for free. Available as an npm package**
+
+[![npm version](https://img.shields.io/npm/v/moracarta)](https://www.npmjs.com/package/moracarta)
+[![npm downloads](https://img.shields.io/npm/dt/moracarta)](https://www.npmjs.com/package/moracarta)
 
 🌐 **[Live Demo](https://moracarta.pages.dev/)**
 
@@ -12,17 +15,16 @@
 🌐 Free web deployment  
 🔒 No database required  
 
-## **Get your own working URL in less than 5 minutes**
+## **You can have your own working URL in less than 5 minutes**
 
 **And it's as simple as:**
 
 ```bash
-git clone https://github.com/WesleyHanauer/moracarta
-cd moracarta
-npm install
-moracarta setup
-moracarta build
-moracarta deploy
+npm init -y
+npm i moracarta
+npx moracarta setup
+npx moracarta build
+npx moracarta deploy
 ```
 
 ### App Demo

package/package.json

@@ -1,10 +1,37 @@
 {
   "name": "moracarta",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "type": "module",
   "description": "",
+  "license": "MIT",
   "main": "index.js",
-   "files": [ "index.html", "vite.config.mjs", "public", "src/commands", "src/config/fonts.js", "src/data/letters.example.js", "src/data/lettersLoader.js", "src/i18n", "src/scripts", "src/services", "src/styles", "src/views" ],
+  "keywords": [
+    "cli",
+    "scaffold",
+    "static-site",
+    "cloudflare",
+    "wrangler",
+    "gift",
+    "envelope",
+    "letters",
+    "romantic",
+    "html-css-js"
+  ],
+  "files": [
+    "index.html",
+    "vite.config.mjs",
+    "public",
+    "src/commands",
+    "src/config/fonts.js",
+    "src/data/letters.example.js",
+    "src/data/lettersLoader.js",
+    "src/i18n",
+    "src/scripts",
+    "src/services",
+    "src/styles",
+    "src/views"
+  ],
+  "postinstall": "node src/commands/postinstall.js",
   "bin": {
     "moracarta": "src/commands/cliConfig.js"
   },
@@ -20,9 +47,7 @@
     "type": "git",
     "url": "git+https://github.com/WesleyHanauer/moracarta.git"
   },
-  "keywords": [],
   "author": "",
-  "license": "ISC",
   "bugs": {
     "url": "https://github.com/WesleyHanauer/moracarta/issues"
   },

package/src/commands/cliConfig.js

@@ -20,13 +20,34 @@ const VITE_ARGS = {
     preview: ["preview"]
 };
 
+const HELP_TEXT = `
+💌 Moracarta — build your own love-letter website
+
+Usage: moracarta <command>
+
+Commands:
+  setup      Scaffold the site into your project and configure it interactively
+  add        Add a letter from a public Google Docs tab
+  remove     Remove a letter you've already added
+  dev        Start the local dev server to preview your site
+  build      Build the site for production
+  preview    Preview the production build locally
+  deploy     Build and deploy the site to Cloudflare Pages
+
+Run 'moracarta setup' first if you haven't already.
+`;
+
 const command = process.argv[2];
 const commandArguments = process.argv.slice(3);
 
+if (!command || command === "--help" || command === "-h") {
+    console.log(HELP_TEXT);
+    process.exit(0);
+}
+
 if (!COMMANDS.has(command)) {
-    console.error(
-        "Usage: moracarta <setup|dev|build|preview|deploy|add|remove> [options]"
-    );
+    console.error(`Unknown command: ${command}`);
+    console.log(HELP_TEXT);
     process.exit(1);
 }
 

package/src/commands/postInstall.js

@@ -0,0 +1,17 @@
+import { resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const packageRoot = resolve(fileURLToPath(new URL("../..", import.meta.url)));
+
+// npm sets INIT_CWD to wherever the install was actually run from.
+// If that's this repo itself, we're installing moracarta's own
+// dependencies for development, not installing moracarta as a
+// package, so skip the message.
+const initCwd = process.env.INIT_CWD;
+
+if (initCwd && resolve(initCwd) === packageRoot) {
+    process.exit(0);
+}
+
+console.log("\n💌 Thanks for installing Moracarta!");
+console.log("Run 'npx moracarta --help' to see available commands.\n");