cloud-wizz-app
v1.0.2
Published
CLI tool to scaffold Cloud Wizz applications
Maintainers
Readme
Cloud Wizz App CLI
A CLI tool to scaffold Cloud Wizz applications with a full-stack template including frontend, backend, and database services.
Installation
Using npx (recommended)
npx cloud-wizz-app my-project-nameGlobal installation
npm install -g cloud-wizz-app
cloud-wizz-app my-project-nameUsage
Create a new project
cloud-wizz-app my-project-nameOr run interactively:
cloud-wizz-appThe CLI will prompt you for a project name and create a new directory with the complete application template.
Start your project
cd my-project-name
docker-compose upFeatures
- 🚀 Quick project scaffolding
- 📦 Pre-configured full-stack template
- 🐳 Docker Compose setup included
- ✨ Interactive prompts with validation
- 🎨 Beautiful CLI output
- ⚠️ Overwrite protection for existing directories
Requirements
- Node.js >= 14.0.0
- Docker and Docker Compose (for running the generated project)
What it does
- Prompts for a project name (if not provided)
- Validates project name format
- Checks for existing directory and prompts to overwrite if needed
- Creates a new directory with the project name
- Copies all boilerplate files from the template
- Updates the package.json with your project name
- Provides next steps for getting started
Template Structure
The generated project includes:
- Frontend application
- Backend API
- Database configuration
- Docker Compose setup
- Pre-configured environment files
Place your boilerplate files in the template/ directory. The CLI will copy everything from this directory to the new project.
Development
Test locally
cd cli-package
npm link
cloud-wizz-app test-projectPrepare template before publishing
The prepublishOnly script automatically prepares the template before publishing to npm:
npm run prepublishOnlyPublishing to npm
- Update version in package.json
- Login to npm:
npm login - Publish:
npm publish
License
MIT
