create-armbed-app

Create a new Armbed kiosk application with zero configuration.

Usage

npm

npm create armbed-app my-kiosk-app

yarn

yarn create armbed-app my-kiosk-app

npx

npx create-armbed-app my-kiosk-app

Options

npx create-armbed-app my-app --template react
npx create-armbed-app my-app --template vanilla-js
npx create-armbed-app my-app --directory ./custom-dir
npx create-armbed-app my-app --no-install --no-git

Available Templates

• react (default) - React 19 + TypeScript + Tailwind CSS v4
• vanilla-js - Pure JavaScript + Tailwind CSS v4

What's Created

my-kiosk-app/
├── frontend/               # Frontend application
│   ├── src/               # Source code
│   ├── package.json       # Frontend dependencies
│   └── ...               # Build configuration
├── scripts/              # Build and config scripts
├── app.config.json       # Application configuration
├── package.json          # Project metadata
└── README.md             # Project documentation

Features

• 🚀 Modern Stack: React 19, TypeScript, Tailwind CSS v4
• 🎨 Kiosk-Optimized: Glassmorphism UI, touch-friendly interfaces
• 🔧 Tauri Ready: Desktop application framework integration
• 🔄 Self-Updating: Built-in update mechanism
• 🛡️ Secure: Configuration management and validation
• 📱 ARM Optimized: Performance optimized for ARM devices
• 🌐 Network Smart: Automatic connectivity management

Next Steps

After creating your project:

1. Start Development

   cd my-kiosk-app
   npm run dev

2. Configure Your App

   # Edit app.config.json for your specific needs
   npm run config  # Generate system configuration

3. Build for Production

   npm run build

Documentation

• Project README: Complete setup and usage guide
• Templates: See frontend/templates/README.md for template documentation

Requirements

• Node.js 18+
• npm, yarn, or pnpm

License

MIT