create-mn-app 0.0.6 → 0.2.0

package/README.md

@@ -11,26 +11,47 @@ cd my-app
 npm run setup
 ```
 
-## Features
-
-- ⚡ **Zero configuration** - Works out of the box with sensible defaults
-- 🔧 **Modern tooling** - TypeScript, hot reloading, auto-compilation
-- 🛡️ **Best practices** - Secure wallet generation, proper project structure
-- 🚀 **Fast setup** - From zero to working app in 60 seconds
-- 🎯 **Developer friendly** - Clear error messages, helpful guides
+## ✨ Features
+
+- 🎯 **Interactive Setup** - Guided project creation with template selection
+- 📦 **Smart Package Manager** - Auto-detects your preferred package manager (npm/yarn/pnpm/bun)
+- 🏥 **Health Checks** - Verify your environment is ready before development
+- ⚡ **Zero Configuration** - Works out of the box with sensible defaults
+- 🔧 **Modern Tooling** - TypeScript, hot reloading, auto-compilation
+- 🛡️ **Best Practices** - Secure wallet generation, proper project structure
+- 🚀 **Fast Setup** - From zero to working app in 60 seconds
+- � **Helpful Errors** - Clear error messages with actionable solutions
 - 📦 **ES Modules** - Modern JavaScript module system
-- 🐳 **Docker integration** - Automated proof server setup
+- 🐳 **Docker Integration** - Automated proof server setup
+
+## 🚀 Quick Start
+
+### Interactive Mode (Recommended)
+
+```bash
+npx create-mn-app
+```
+
+You'll be prompted to:
+
+1. **Enter your project name** - Choose a descriptive name for your app
+2. **Select a template** - Pick from available templates or see what's coming soon
+3. **Choose configuration** - Package manager, git, and other options
 
-## Quick Start
+### Command Line Mode
 
 ```bash
-# Create a new Midnight app
+# Create with defaults
 npx create-mn-app my-midnight-app
 
-# Navigate to your project
-cd my-midnight-app
+# Create with specific template
+npx create-mn-app my-app --template hello-world
 
-# Setup and deploy your contract
+# Use specific package manager
+npx create-mn-app my-app --use-pnpm
+
+# Navigate and setup
+cd my-app
 npm run setup
 ```
 
@@ -46,7 +67,7 @@ Your generated project includes:
 - 📋 **Environment Config** - `.env` file with network configuration
 - 🔄 **Git Ready** - Initialized git repository with proper `.gitignore`
 
-## Available Commands
+## 📚 Available Commands
 
 Once your project is created, you can run:
 
@@ -58,6 +79,19 @@ Complete setup pipeline:
 2. Builds TypeScript to JavaScript
 3. Deploys contracts to the network
 
+### `npm run health-check`
+
+🏥 Verify your development environment:
+
+- ✓ Node.js version (18+)
+- ✓ Docker availability
+- ✓ Environment configuration
+- ✓ Wallet setup
+- ✓ Dependencies installed
+- ✓ Project built correctly
+
+Run this command before development to catch issues early!
+
 ### `npm run cli`
 
 Opens an interactive command-line interface to:
@@ -67,6 +101,10 @@ Opens an interactive command-line interface to:
 - Retrieve stored messages
 - Test contract functionality
 
+### `npm run check-balance`
+
+Checks your wallet balance. Useful for verifying if test tokens from the faucet have arrived before deploying.
+
 ### `npm run compile`
 
 Compiles your Compact smart contracts from `contracts/` to `contracts/managed/`
@@ -79,10 +117,6 @@ Builds your TypeScript source code to JavaScript in the `dist/` directory
 
 Deploys your compiled contract to the Midnight testnet
 
-### `npm run check-balance`
-
-Checks your wallet balance. Useful for verifying if test tokens from the faucet have arrived before deploying.
-
 ## Project Structure
 
 ```
@@ -104,9 +138,13 @@ my-midnight-app/
 └── nodemon.json
 ```
 
-## Templates
+## 🎨 Templates
+
+Choose from various templates to kickstart your Midnight project:
 
-### Hello World (Default)
+### ✅ Available Now
+
+#### **Hello World** (Default)
 
 A simple message storage contract demonstrating:
 
@@ -115,42 +153,116 @@ A simple message storage contract demonstrating:
 - Contract deployment
 - Interactive testing
 
-**More templates coming soon!**
+```bash
+npx create-mn-app my-app --template hello-world
+```
+
+#### **Counter DApp**
+
+Real-world example from midnightntwrk demonstrating:
+
+- Increment/decrement state management
+- Zero-knowledge proofs on testnet
+- Compact compiler integration
+- Full CLI interface
+
+```bash
+npx create-mn-app my-counter --template counter
+```
+
+_Automatically cloned from [midnightntwrk/example-counter](https://github.com/midnightntwrk/example-counter)_
+
+**Requirements:** Node.js 22+, Docker, Compact compiler
+
+### 🔜 Coming Soon
+
+#### **Bulletin Board (Bboard)**
+
+Bulletin board with multi-user interactions and privacy patterns
+
+#### **Decentralized Exchange (DEX)**
+
+Decentralized exchange using OpenZeppelin FungibleToken
+
+#### **Midnight Kitties**
 
-## Requirements
+Full stack DApp using NFT smart contract library (Crypto Kitties on Midnight)
 
-- **Node.js** 18.0.0 or higher
+_These templates are under development. Star the repo to stay updated!_
+
+## ⚙️ Requirements
+
+- **Node.js** 22.0.0 or higher (required for all templates)
 - **Docker** (for running the proof server)
-- **npm**, **yarn**, or **pnpm** package manager
+- **npm**, **yarn**, **pnpm**, or **bun** package manager
+- **Compact Compiler** (required for Counter and future templates - CLI will guide installation)
+
+> **Note:** The CLI automatically checks Node.js version on startup and will guide you if an upgrade is needed.
+
+## 📦 Package Manager Options
+
+The CLI automatically detects your preferred package manager! It checks:
 
-## Package Manager Options
+1. Lock files in your directory (package-lock.json, yarn.lock, pnpm-lock.yaml, bun.lockb)
+2. Environment variables set by your package manager
+3. Available package managers on your system
 
-You can use your preferred package manager:
+You can also explicitly specify:
 
 ```bash
-# npm (default)
-npx create-mn-app my-app
+# npm
+npx create-mn-app my-app --use-npm
 
 # Yarn
-npx create-mn-app my-app --yarn
+npx create-mn-app my-app --use-yarn
 
 # pnpm
-npx create-mn-app my-app --pnpm
+npx create-mn-app my-app --use-pnpm
+
+# Bun
+npx create-mn-app my-app --use-bun
 ```
 
-## Usage Options
+All commands in the success message will use your chosen package manager! 🎉
+
+## ⚙️ CLI Options
 
 ```bash
 npx create-mn-app [project-name] [options]
 
+Arguments:
+  project-name              Name of your project (interactive prompt if omitted)
+
 Options:
-  --template <name>    Specify a template (default: hello-world)
-  --yarn              Use Yarn as package manager
-  --pnpm              Use pnpm as package manager
-  --npm               Use npm as package manager
-  --skip-install      Skip dependency installation
-  --skip-git          Skip git initialization
-  -h, --help          Display help information
+  -t, --template <name>     Template to use (hello-world, counter, bboard, dex, midnight-kitties)
+  --use-npm                 Use npm as package manager
+  --use-yarn                Use Yarn as package manager
+  --use-pnpm                Use pnpm as package manager
+  --use-bun                 Use bun as package manager
+  --skip-install            Skip dependency installation
+  --skip-git                Skip git initialization
+  --verbose                 Show detailed output including stack traces
+  -h, --help                Display help information
+  -V, --version             Display version number
+```
+
+### Examples
+
+```bash
+# Interactive mode (recommended)
+npx create-mn-app
+
+# With project name
+npx create-mn-app my-midnight-dapp
+
+# Specific template and package manager
+npx create-mn-app my-dex --template dex --use-pnpm
+
+# Skip installation (for CI/CD)
+npx create-mn-app my-app --skip-install --skip-git
+
+# Verbose output for debugging
+npx create-mn-app my-app --verbose
 ```
 
 ## Environment Configuration
@@ -170,7 +282,34 @@ PROOF_SERVER_URL=http://localhost:6300
 
 ⚠️ **Important**: Never commit your `.env` file or share your wallet seed phrase!
 
-## Troubleshooting
+## 🔧 Troubleshooting
+
+### Node.js version error
+
+If you see "Node.js Version Error":
+
+```bash
+# Check your version
+node --version
+
+# Install Node.js 22+ from https://nodejs.org
+# Or use nvm:
+nvm install 22
+nvm use 22
+```
+
+The CLI automatically checks for Node.js 22+ before running!
+
+### Environment issues
+
+Run the health check to diagnose problems:
+
+```bash
+cd my-app
+npm run health-check
+```
+
+This will show you exactly what needs to be fixed. ✨
 
 ### Waiting for faucet funds
 
@@ -217,6 +356,21 @@ Ensure Docker Desktop is running before starting the development server:
 
 ```bash
 docker --version
+
+# If not installed, get it from:
+# https://docker.com
+```
+
+### Permission errors
+
+If you encounter EACCES errors:
+
+```bash
+# Fix npm permissions (recommended)
+# See: https://docs.npmjs.com/resolving-eacces-permissions-errors
+
+# Or use a version manager like nvm (better solution)
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
 ```
 
 ## Learn More

package/dist/cli.js

@@ -5,28 +5,39 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const chalk_1 = __importDefault(require("chalk"));
-const create_app_1 = require("./create-app");
+const create_app_js_1 = require("./create-app.js");
+const error_handler_js_1 = require("./utils/error-handler.js");
 const program = new commander_1.Command();
+// Check Node.js version before anything else (require 22+)
+error_handler_js_1.ErrorHandler.checkNodeVersion(22);
 program
     .name("create-midnight-app")
     .description("Create a new Midnight Network application")
-    .version("1.0.0")
+    .version("0.2.0")
     .argument("[project-directory]", "Directory name for your project")
-    .option("-t, --template <name>", "Template to use", "hello-world")
-    .option("--use-npm", "Use npm instead of yarn")
-    .option("--use-pnpm", "Use pnpm instead of yarn")
+    .option("-t, --template <name>", "Template to use (hello-world, counter, bboard, dex, midnight-kitties)")
+    .option("--use-npm", "Use npm explicitly")
+    .option("--use-yarn", "Use yarn explicitly")
+    .option("--use-pnpm", "Use pnpm explicitly")
+    .option("--use-bun", "Use bun explicitly")
     .option("--skip-install", "Skip package installation")
     .option("--skip-git", "Skip git repository initialization")
     .option("--verbose", "Show detailed output")
     .action(async (projectDirectory, options) => {
     console.log(chalk_1.default.blue.bold("🌙 Create Midnight App\n"));
     try {
-        await (0, create_app_1.createApp)(projectDirectory, options);
+        await (0, create_app_js_1.createApp)(projectDirectory, options);
     }
     catch (error) {
-        console.error(chalk_1.default.red("✖ Error creating app:"), error instanceof Error ? error.message : error);
-        if (options.verbose && error instanceof Error) {
-            console.error(chalk_1.default.gray(error.stack));
+        console.error();
+        console.error(error_handler_js_1.ErrorHandler.formatError(error instanceof Error ? error : new Error(String(error)), "creating app"));
+        if (error instanceof Error) {
+            error_handler_js_1.ErrorHandler.suggestSolution(error);
+            if (options.verbose && error.stack) {
+                console.error(chalk_1.default.gray("Stack trace:"));
+                console.error(chalk_1.default.gray(error.stack));
+                console.error();
+            }
         }
         process.exit(1);
     }

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;AAAA,yCAAoC;AACpC,kDAA0B;AAC1B,6CAAyC;AAEzC,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,qBAAqB,CAAC;KAC3B,WAAW,CAAC,2CAA2C,CAAC;KACxD,OAAO,CAAC,OAAO,CAAC;KAChB,QAAQ,CAAC,qBAAqB,EAAE,iCAAiC,CAAC;KAClE,MAAM,CAAC,uBAAuB,EAAE,iBAAiB,EAAE,aAAa,CAAC;KACjE,MAAM,CAAC,WAAW,EAAE,yBAAyB,CAAC;KAC9C,MAAM,CAAC,YAAY,EAAE,0BAA0B,CAAC;KAChD,MAAM,CAAC,gBAAgB,EAAE,2BAA2B,CAAC;KACrD,MAAM,CAAC,YAAY,EAAE,oCAAoC,CAAC;KAC1D,MAAM,CAAC,WAAW,EAAE,sBAAsB,CAAC;KAC3C,MAAM,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,EAAE;IAC1C,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC,CAAC;IAEzD,IAAI,CAAC;QACH,MAAM,IAAA,sBAAS,EAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CACX,eAAK,CAAC,GAAG,CAAC,uBAAuB,CAAC,EAClC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAC/C,CAAC;QACF,IAAI,OAAO,CAAC,OAAO,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC9C,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,KAAK,EAAE,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;;AAAA,yCAAoC;AACpC,kDAA0B;AAC1B,mDAA4C;AAC5C,+DAAwD;AAExD,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,2DAA2D;AAC3D,+BAAY,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;AAElC,OAAO;KACJ,IAAI,CAAC,qBAAqB,CAAC;KAC3B,WAAW,CAAC,2CAA2C,CAAC;KACxD,OAAO,CAAC,OAAO,CAAC;KAChB,QAAQ,CAAC,qBAAqB,EAAE,iCAAiC,CAAC;KAClE,MAAM,CACL,uBAAuB,EACvB,uEAAuE,CACxE;KACA,MAAM,CAAC,WAAW,EAAE,oBAAoB,CAAC;KACzC,MAAM,CAAC,YAAY,EAAE,qBAAqB,CAAC;KAC3C,MAAM,CAAC,YAAY,EAAE,qBAAqB,CAAC;KAC3C,MAAM,CAAC,WAAW,EAAE,oBAAoB,CAAC;KACzC,MAAM,CAAC,gBAAgB,EAAE,2BAA2B,CAAC;KACrD,MAAM,CAAC,YAAY,EAAE,oCAAoC,CAAC;KAC1D,MAAM,CAAC,WAAW,EAAE,sBAAsB,CAAC;KAC3C,MAAM,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,EAAE;IAC1C,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC,CAAC;IAEzD,IAAI,CAAC;QACH,MAAM,IAAA,yBAAS,EAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,OAAO,CAAC,KAAK,CACX,+BAAY,CAAC,WAAW,CACtB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EACzD,cAAc,CACf,CACF,CAAC;QAEF,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,+BAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YAEpC,IAAI,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;gBACnC,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;gBAC1C,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;gBACvC,OAAO,CAAC,KAAK,EAAE,CAAC;YAClB,CAAC;QACH,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/dist/create-app.d.ts

@@ -1,7 +1,9 @@
 export interface CreateAppOptions {
-    template: string;
+    template?: string;
     useNpm?: boolean;
+    useYarn?: boolean;
     usePnpm?: boolean;
+    useBun?: boolean;
     skipInstall?: boolean;
     skipGit?: boolean;
     verbose?: boolean;

package/dist/create-app.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-app.d.ts","sourceRoot":"","sources":["../src/create-app.ts"],"names":[],"mappings":"AAYA,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,wBAAsB,SAAS,CAC7B,gBAAgB,EAAE,MAAM,GAAG,SAAS,EACpC,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,IAAI,CAAC,CAwGf"}
+{"version":3,"file":"create-app.d.ts","sourceRoot":"","sources":["../src/create-app.ts"],"names":[],"mappings":"AAyBA,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,wBAAsB,SAAS,CAC7B,gBAAgB,EAAE,MAAM,GAAG,SAAS,EACpC,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,IAAI,CAAC,CA0If"}