dokio-create-template 1.0.0 → 1.0.2

package/SETUP.md

@@ -0,0 +1,192 @@
+# Setup Guide - dokio-create-template
+
+This guide will walk you through setting up and publishing the `dokio-create-template` npm package.
+
+## Prerequisites
+
+- Node.js 14.0.0 or higher
+- npm account (for publishing)
+
+## Installation for Development
+
+1. **Clone or create the package directory:**
+   ```bash
+   cd dokio-create-template
+   ```
+
+2. **Install dependencies:**
+   ```bash
+   npm install
+   ```
+
+3. **Test the CLI locally:**
+   ```bash
+   node bin/cli.js
+   ```
+
+   Or link it globally to test:
+   ```bash
+   npm link
+   dokio-create-template
+   ```
+
+## Publishing to npm
+
+### First Time Setup
+
+1. **Login to npm:**
+   ```bash
+   npm login
+   ```
+
+2. **Verify your package name is available:**
+   ```bash
+   npm search dokio-create-template
+   ```
+
+3. **Update package.json with your details:**
+   - Change author name
+   - Add your repository URL
+   - Verify version number
+
+4. **Publish the package:**
+   ```bash
+   npm publish
+   ```
+
+### Updating the Package
+
+1. **Make your changes**
+
+2. **Update version number:**
+   ```bash
+   # For bug fixes
+   npm version patch
+   
+   # For new features
+   npm version minor
+   
+   # For breaking changes
+   npm version major
+   ```
+
+3. **Publish the update:**
+   ```bash
+   npm publish
+   ```
+
+## Testing
+
+### Test Template Generation
+
+```bash
+# Test general template
+dokio-create-template
+# Select: General (Image)
+
+# Test PDF template
+dokio-create-template
+# Select: PDF
+
+# Test email template
+dokio-create-template
+# Select: Email
+
+# Test video template
+dokio-create-template
+# Select: Video
+```
+
+### Verify Output
+
+After generation, check that all files are created:
+- `index.html`
+- `style.scss.hbs`
+- `data.yaml`
+- `CHANGELOG.md`
+
+## Troubleshooting
+
+### "Command not found" error
+
+If you get a "command not found" error after global installation:
+
+1. Check npm global bin path:
+   ```bash
+   npm config get prefix
+   ```
+
+2. Add to your PATH (add to ~/.bashrc or ~/.zshrc):
+   ```bash
+   export PATH="$PATH:$(npm config get prefix)/bin"
+   ```
+
+3. Reload your shell:
+   ```bash
+   source ~/.bashrc  # or ~/.zshrc
+   ```
+
+### Module not found errors
+
+Make sure dependencies are installed:
+```bash
+npm install
+```
+
+### Permission errors on publish
+
+Make sure you're logged in:
+```bash
+npm whoami
+npm login
+```
+
+## Directory Structure
+
+```
+dokio-create-template/
+├── bin/
+│   └── cli.js              # CLI entry point
+├── lib/
+│   └── creator.js          # Main logic
+├── templates/
+│   ├── general/
+│   │   ├── index.html
+│   │   ├── style.scss.hbs
+│   │   ├── data.yaml
+│   │   └── CHANGELOG.md
+│   ├── pdf/
+│   │   ├── index.html
+│   │   ├── style.scss.hbs
+│   │   ├── data.yaml
+│   │   └── CHANGELOG.md
+│   ├── email/
+│   │   ├── index.html
+│   │   ├── style.scss.hbs
+│   │   ├── data.yaml
+│   │   └── CHANGELOG.md
+│   └── video/
+│       ├── index.html
+│       ├── style.scss.hbs
+│       ├── data.yaml
+│       └── CHANGELOG.md
+├── index.js
+├── package.json
+├── README.md
+├── LICENSE
+└── .gitignore
+```
+
+## Next Steps
+
+1. Customize the templates in the `templates/` directory to match your organization's needs
+2. Add more template types if needed
+3. Enhance the CLI with additional options
+4. Add validation for template uploads
+5. Create tests
+
+## Support
+
+For issues or questions:
+- GitHub Issues: [your-repo-url]
+- Dokio Support: https://support.dokio.com

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "dokio-create-template",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "CLI tool to scaffold Dokio templates (general, pdf, email, video)",
   "main": "index.js",
   "bin": {
-    "dokio-create-template": "bin/cli.js"
+    "dokio-create-template": "./bin/cli.js"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -14,23 +14,10 @@
     "template",
     "cli",
     "scaffold",
-    "generator",
-    "pdf",
-    "email",
-    "video",
-    "create-template",
-    "boilerplate"
+    "generator"
   ],
   "author": "Dokio",
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/yourusername/dokio-create-template.git"
-  },
-  "bugs": {
-    "url": "https://github.com/yourusername/dokio-create-template/issues"
-  },
-  "homepage": "https://github.com/yourusername/dokio-create-template#readme",
   "dependencies": {
     "inquirer": "^8.2.5",
     "chalk": "^4.1.2",
@@ -38,13 +25,5 @@
   },
   "engines": {
     "node": ">=14.0.0"
-  },
-  "files": [
-    "bin/",
-    "lib/",
-    "templates/",
-    "index.js",
-    "README.md",
-    "LICENSE"
-  ]
+  }
 }