@blu1606/create-walrus-app 0.1.0 → 0.1.4

package/README.md

@@ -0,0 +1,215 @@
+# create-walrus-app
+
+Interactive CLI for scaffolding Walrus applications on the Sui blockchain.
+
+## Quick Start
+
+```bash
+# Using npm
+npx @blu1606/create-walrus-app
+
+# Using pnpm
+pnpm create @blu1606/walrus-app
+
+# Using yarn
+yarn create @blu1606/walrus-app
+```
+
+## What is Walrus?
+
+Walrus is a decentralized storage network built on the Sui blockchain, designed for storing and retrieving large files efficiently and securely.
+
+## Features
+
+- 🚀 **Interactive CLI** - Easy-to-use prompts guide you through project setup
+- 📦 **Multiple Templates** - Choose from various pre-built templates
+- ⚡ **Modern Stack** - Built with TypeScript, React, and Vite
+- 🎨 **Ready to Use** - Includes all necessary dependencies and configurations
+- 🔧 **Customizable** - Easy to extend and modify for your needs
+
+## Available Templates
+
+### 1. Simple Upload
+Basic file upload and download functionality.
+- Upload any file to Walrus
+- Get Blob ID after upload
+- Download file by Blob ID
+- File size display
+
+### 2. Gallery
+Manage multiple files with a persistent index.
+- Upload multiple files
+- Grid view of all files
+- Local index (localStorage)
+- Delete files from gallery
+- File metadata display
+
+### 3. React Template
+Full React application template with TypeScript.
+- Component-based architecture
+- TypeScript support
+- Modern React patterns
+- Vite for fast development
+
+### 4. SDK Mysten
+Integration with Mysten Labs SDK.
+- Wallet integration
+- Transaction handling
+- Sui blockchain interactions
+
+### 5. Base Template
+Minimal starting point for custom implementations.
+- Clean slate
+- Essential Walrus utilities
+- No UI framework dependencies
+
+## Usage
+
+### Create a New Project
+
+```bash
+npx @blu1606/create-walrus-app my-walrus-app
+```
+
+Follow the interactive prompts:
+1. Enter your project name
+2. Select a template
+3. Choose package manager (npm/pnpm/yarn)
+4. Wait for dependencies installation
+
+### Start Development
+
+```bash
+cd my-walrus-app
+npm run dev
+```
+
+Your app will be running at `http://localhost:5173`
+
+## Project Structure
+
+```
+my-walrus-app/
+├── src/
+│   ├── components/     # React components
+│   ├── utils/          # Utility functions
+│   ├── App.tsx         # Main app component
+│   └── main.tsx        # Entry point
+├── public/             # Static assets
+├── package.json        # Dependencies and scripts
+├── tsconfig.json       # TypeScript configuration
+└── vite.config.ts      # Vite configuration
+```
+
+## Requirements
+
+- Node.js >= 20.0.0
+- npm >= 9.0.0 or pnpm >= 9.0.0
+
+## Common Scripts
+
+All templates include these scripts:
+
+```bash
+# Start development server
+npm run dev
+
+# Build for production
+npm run build
+
+# Preview production build
+npm run preview
+
+# Lint code
+npm run lint
+```
+
+## Configuration
+
+### Walrus Configuration
+
+Each template comes with Walrus utilities pre-configured. You can customize:
+
+- **Aggregator URL**: Set in your Walrus client configuration
+- **Publisher URL**: Configure for file uploads
+- **Storage settings**: Adjust based on your needs
+
+### Environment Variables
+
+Create a `.env` file in your project root:
+
+```env
+VITE_WALRUS_AGGREGATOR_URL=https://aggregator.walrus-testnet.walrus.space
+VITE_WALRUS_PUBLISHER_URL=https://publisher.walrus-testnet.walrus.space
+```
+
+## API Reference
+
+### Upload File
+
+```typescript
+import { uploadToWalrus } from './utils/walrus';
+
+const blob = await uploadToWalrus(file);
+console.log('Blob ID:', blob.blobId);
+```
+
+### Download File
+
+```typescript
+import { downloadFromWalrus } from './utils/walrus';
+
+const blob = await downloadFromWalrus(blobId);
+// Use the blob data
+```
+
+## Troubleshooting
+
+### Installation Issues
+
+If you encounter installation errors:
+
+```bash
+# Clear npm cache
+npm cache clean --force
+
+# Try with different package manager
+pnpm create @blu1606/walrus-app
+```
+
+### Build Errors
+
+Ensure you're using the correct Node.js version:
+
+```bash
+node --version  # Should be >= 20.0.0
+```
+
+## Examples
+
+Check out the [examples directory](https://github.com/blu1606/walrus-starter-kit/tree/main/examples) for complete working applications.
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](https://github.com/blu1606/walrus-starter-kit/blob/main/CONTRIBUTING.md) for details.
+
+## Resources
+
+- [Walrus Documentation](https://docs.walrus.site/)
+- [Sui Documentation](https://docs.sui.io/)
+- [GitHub Repository](https://github.com/blu1606/walrus-starter-kit)
+- [Issue Tracker](https://github.com/blu1606/walrus-starter-kit/issues)
+
+## License
+
+MIT © [blu1606](https://github.com/blu1606)
+
+## Support
+
+- 📧 Email: dongthanhquandtq@gmail.com
+- 🐛 Issues: [GitHub Issues](https://github.com/blu1606/walrus-starter-kit/issues)
+- 💬 Discussions: [GitHub Discussions](https://github.com/blu1606/walrus-starter-kit/discussions)
+
+---
+
+Made with ❤️ for the Walrus and Sui community

package/dist/context.js

@@ -36,8 +36,9 @@ export function buildContext(args, promptResults) {
         sdk,
         framework,
         useCase,
-        analytics: Boolean(merged.analytics),
-        tailwind: Boolean(merged.tailwind),
+        // Temporarily disabled until templates are implemented
+        analytics: false, // Boolean(merged.analytics),
+        tailwind: false, // Boolean(merged.tailwind),
         packageManager: packageManager,
     };
 }

package/dist/index.js

@@ -23,8 +23,9 @@ program
     .option('--sdk <sdk>', 'SDK to use (mysten | tusky | hibernuts)')
     .option('--framework <framework>', 'Framework (react | vue | plain-ts)')
     .option('--use-case <use-case>', 'Use case (simple-upload | gallery | defi-nft)')
-    .option('--analytics', 'Include Blockberry analytics', false)
-    .option('--no-tailwind', 'Exclude Tailwind CSS')
+    // TODO: Re-enable when templates are implemented
+    // .option('--analytics', 'Include Blockberry analytics', false)
+    // .option('--no-tailwind', 'Exclude Tailwind CSS')
     .option('--skip-install', 'Skip dependency installation', false)
     .option('--skip-git', 'Skip git initialization', false)
     .option('--skip-validation', 'Skip project validation', false)

package/dist/prompts.js

@@ -73,16 +73,18 @@ export async function runPrompts(initial = {}) {
             },
         },
         {
-            type: initial.analytics !== undefined ? null : 'confirm',
+            // TODO: Re-enable when analytics template is created
+            type: null, // Temporarily disabled - template not implemented
             name: 'analytics',
             message: 'Include Blockberry analytics?',
             initial: false,
         },
         {
-            type: initial.tailwind !== undefined ? null : 'confirm',
+            // TODO: Re-enable when tailwind template is created
+            type: null, // Temporarily disabled - template not implemented
             name: 'tailwind',
             message: 'Include Tailwind CSS?',
-            initial: true,
+            initial: false, // Changed to false to prevent layer lookup
         },
         {
             type: initial.packageManager ? null : 'select',

package/package.json

@@ -1,68 +1,69 @@
-{
-  "name": "@blu1606/create-walrus-app",
-  "version": "0.1.0",
-  "description": "Interactive CLI for scaffolding Walrus applications",
-  "type": "module",
-  "bin": {
-    "create-walrus-app": "./dist/index.js"
-  },
-  "files": [
-    "dist",
-    "templates"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:ui": "vitest --ui",
-    "test:coverage": "vitest run --coverage",
-    "test:integration": "node tests/integration/integration.test.mjs",
-    "test:validation": "node tests/integration/validation.test.mjs",
-    "test:manual": "node tests/integration/manual.test.js",
-    "test:e2e": "node tests/integration/cli.e2e.test.mjs",
-    "test:all": "vitest run && pnpm test:e2e",
-    "prepublishOnly": "pnpm build"
-  },
-  "keywords": [
-    "walrus",
-    "sui",
-    "scaffold",
-    "cli",
-    "template"
-  ],
-  "author": "blu1606 dongthanhquandtq@gmail.com",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/blu1606/walrus-starter-kit.git",
-    "directory": "packages/cli"
-  },
-  "dependencies": {
-    "commander": "^11.1.0",
-    "cross-spawn": "^7.0.3",
-    "fs-extra": "^11.2.0",
-    "kleur": "^4.1.5",
-    "prompts": "^2.4.2",
-    "sort-package-json": "^2.10.1"
-  },
-  "devDependencies": {
-    "@types/cross-spawn": "^6.0.6",
-    "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.11.0",
-    "@types/prompts": "^2.4.9",
-    "@vitest/coverage-v8": "^4.0.17",
-    "@vitest/ui": "^4.0.17",
-    "execa": "^9.5.2",
-    "strip-ansi": "^7.1.0",
-    "typescript": "^5.3.0",
-    "vitest": "^4.0.17"
-  },
-  "engines": {
-    "node": "^20.0.0 || ^22.0.0 || >=24.0.0",
-    "pnpm": ">=9.0.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  }
+{
+  "name": "@blu1606/create-walrus-app",
+  "version": "0.1.4",
+  "description": "Interactive CLI for scaffolding Walrus applications",
+  "type": "module",
+  "bin": {
+    "create-walrus-app": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:ui": "vitest --ui",
+    "test:coverage": "vitest run --coverage",
+    "test:integration": "node tests/integration/integration.test.mjs",
+    "test:validation": "node tests/integration/validation.test.mjs",
+    "test:manual": "node tests/integration/manual.test.js",
+    "test:e2e": "node tests/integration/cli.e2e.test.mjs",
+    "test:all": "vitest run && pnpm test:e2e",
+    "prepublishOnly": "pnpm build"
+  },
+  "keywords": [
+    "walrus",
+    "sui",
+    "scaffold",
+    "cli",
+    "template"
+  ],
+  "author": "blu1606 dongthanhquandtq@gmail.com",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/blu1606/walrus-starter-kit.git",
+    "directory": "packages/cli"
+  },
+  "dependencies": {
+    "commander": "^11.1.0",
+    "cross-spawn": "^7.0.3",
+    "fs-extra": "^11.2.0",
+    "kleur": "^4.1.5",
+    "prompts": "^2.4.2",
+    "sort-package-json": "^2.10.1"
+  },
+  "devDependencies": {
+    "@types/cross-spawn": "^6.0.6",
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^20.11.0",
+    "@types/prompts": "^2.4.9",
+    "@vitest/coverage-v8": "^4.0.17",
+    "@vitest/ui": "^4.0.17",
+    "execa": "^9.5.2",
+    "strip-ansi": "^7.1.0",
+    "typescript": "^5.3.0",
+    "vitest": "^4.0.17"
+  },
+  "engines": {
+    "node": "^20.0.0 || ^22.0.0 || >=24.0.0",
+    "pnpm": ">=9.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/templates/gallery/src/App.tsx

@@ -1,5 +1,5 @@
 import { useState } from 'react';
-import { Layout } from '../../react/src/components/Layout.js';
+import { Layout } from './components/Layout.js';
 import { GalleryGrid } from './components/GalleryGrid.js';
 import { UploadModal } from './components/UploadModal.js';
 import './styles.css';

package/templates/gallery/src/components/FileCard.tsx

@@ -1,4 +1,4 @@
-import { formatBytes, formatDate } from '../../../base/src/utils/format.js';
+import { formatBytes, formatDate } from '../utils/format.js';
 import { removeItem } from '../utils/index-manager.js';
 import type { GalleryItem } from '../types/gallery.js';
 

package/templates/gallery/src/components/UploadModal.tsx

@@ -1,5 +1,5 @@
 import { useState } from 'react';
-import { useUpload } from '../../../react/src/hooks/useStorage.js';
+import { useUpload } from '../hooks/useStorage.js';
 import { addItem } from '../utils/index-manager.js';
 
 interface UploadModalProps {

package/templates/react/src/index.ts

@@ -1,5 +1,5 @@
 // Re-export storage adapter from SDK layer for use case templates
-export { storageAdapter } from '../../sdk-mysten/src/index.js';
+export { storageAdapter } from './adapters/storage.js';
 
 // Re-export base adapter types
 export type {
@@ -7,4 +7,4 @@ export type {
   BlobMetadata,
   UploadOptions,
   DownloadOptions,
-} from '../../base/src/adapters/storage.js';
+} from './adapters/storage.js';

package/templates/sdk-mysten/package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "description": "Mysten Walrus SDK layer for walrus-starter-kit",
   "dependencies": {
-    "@mysten/walrus": "^1.0.0",
+    "@mysten/walrus": "^0.9.0",
     "@mysten/sui": "^1.10.0"
   },
   "peerDependencies": {

package/templates/sdk-mysten/src/adapter.ts

@@ -3,7 +3,7 @@ import type {
   BlobMetadata,
   UploadOptions,
   DownloadOptions,
-} from '../../base/src/adapters/storage.js';
+} from '../adapters/storage.js';
 import { getWalrusClient } from './client.js';
 
 export class MystenStorageAdapter implements StorageAdapter {

package/templates/sdk-mysten/src/client.ts

@@ -1,8 +1,8 @@
 import { WalrusClient } from '@mysten/walrus';
 import { SuiClient, getFullnodeUrl } from '@mysten/sui/client';
-import { loadEnv } from '../../base/src/utils/env.js';
+import { loadEnv } from '../utils/env.js';
 import { getNetworkConfig } from './config.js';
-import type { WalrusNetwork } from '../../base/src/types/walrus.js';
+import type { WalrusNetwork } from '../types/walrus.js';
 
 let walrusClient: WalrusClient | null = null;
 

package/templates/sdk-mysten/src/config.ts

@@ -1,4 +1,4 @@
-import type { WalrusNetwork } from '../../base/src/types/walrus.js';
+import type { WalrusNetwork } from '../types/walrus.js';
 
 export interface MystenWalrusConfig {
   network: WalrusNetwork;

package/templates/sdk-mysten/src/index.ts

@@ -8,4 +8,4 @@ export type {
   BlobMetadata,
   UploadOptions,
   DownloadOptions,
-} from '../../base/src/adapters/storage.js';
+} from '../adapters/storage.js';

package/templates/simple-upload/src/App.tsx

@@ -1,4 +1,4 @@
-import { Layout } from '../../react/src/components/Layout.js';
+import { Layout } from './components/Layout.js';
 import { UploadForm } from './components/UploadForm.js';
 import { FilePreview } from './components/FilePreview.js';
 import './styles.css';

package/templates/simple-upload/src/components/FilePreview.tsx

@@ -1,5 +1,5 @@
 import { useState } from 'react';
-import { useDownload } from '../../../react/src/hooks/useStorage.js';
+import { useDownload } from '../hooks/useStorage.js';
 
 export function FilePreview() {
   const [blobId, setBlobId] = useState('');

package/templates/simple-upload/src/components/UploadForm.tsx

@@ -1,5 +1,5 @@
 import { useState } from 'react';
-import { useUpload } from '../../../react/src/hooks/useStorage.js';
+import { useUpload } from '../hooks/useStorage.js';
 
 export function UploadForm() {
   const [selectedFile, setSelectedFile] = useState<File | null>(null);