create-fluid-pwa
v1.0.0
Published
π Interactive CLI to create Fluid PWA projects with customizable features and templates
Maintainers
Readme
create-fluid-pwa
π Interactive CLI to create Fluid PWA projects with customizable features and templates
Similar to create-next-app, but specifically designed for offline-first Progressive Web Apps with Fluid PWA framework.
Quick Start
npx create-fluid-pwa@latest
# or
npm create fluid-pwa@latest
# or
yarn create fluid-pwa
# or
pnpm create fluid-pwaFeatures
π¨ Interactive Terminal UI
Beautiful, intuitive prompts powered by @clack/prompts with:
- Project name validation
- Template selection with descriptions
- Feature selection (batteries included)
- Styling framework choice
- Package manager preference
- Configuration summary
π¦ Templates
Choose from pre-configured templates:
- π¦ Basic - Minimal setup with essential features
- π― Full Featured - Complete setup with all batteries included
- π E-commerce - Optimized for online stores and marketplaces
- π Dashboard - Perfect for admin panels and analytics
- π Blog/CMS - Content management and publishing
- π₯ Social Media - Social features and user interactions
π Batteries (Features)
Select from a comprehensive set of features:
- π Authentication - User login/logout with offline support
- π Background Sync - Automatic data synchronization
- π’ Push Notifications - Web push notifications support
- π File Storage - Offline file management and caching
- β‘ Real-time Updates - WebSocket/SSE integration
- π Analytics - Offline-first analytics tracking
- π Data Encryption - Client-side data encryption
- βοΈ WebAssembly - WASM modules for performance
- π· Web Workers - Background processing threads
- π¨ UI Component Library - Pre-built PWA-optimized components
π¨ Styling Options
- Tailwind CSS - Utility-first CSS framework
- Styled Components - CSS-in-JS styling
- Emotion - CSS-in-JS with excellent performance
- Vanilla CSS - Plain CSS with CSS modules
π¦ Package Managers
- npm
- Yarn
- pnpm
- Bun
Usage Examples
Interactive Mode (Recommended)
npx create-fluid-pwa@latestNon-Interactive Mode (Coming Soon)
npx create-fluid-pwa@latest my-app --template full-featured --features auth,sync,push-notifications --typescriptWhat's Generated
Your new Fluid PWA project includes:
my-fluid-pwa/
βββ src/
β βββ app/
β β βββ page.tsx # Main application page
β β βββ layout.tsx # Root layout
β β βββ globals.css # Global styles
β βββ lib/
βββ public/
β βββ manifest.json # PWA manifest
β βββ icons/ # PWA icons
βββ package.json # Dependencies and scripts
βββ next.config.js # Next.js configuration
βββ tailwind.config.js # Tailwind configuration
βββ README.md # Project documentationGetting Started After Creation
cd my-fluid-pwa
npm run devOpen http://localhost:3000 to see your new Fluid PWA.
Development
To work on the CLI tool itself:
git clone https://github.com/fluid-pwa/create-fluid-pwa.git
cd create-fluid-pwa
npm install
npm run devContributing
We welcome contributions! Please see our Contributing Guide.
License
MIT Β© Fluid PWA Team
Built with β€οΈ by the Fluid PWA community
