A cross-platform Node.js based CLI tool that creates Progressive Web App (PWA) with Next.js. You can also integrate tailwind with the Next.js PWA using this CLI with a single command.
- Simple: One command Next.js Progressive Web App setup
- Cross-platform: Works on all available operating systems including Linux, macOS, and Windows
-
Support: Also supports TypeScript Next.js PWA with
--typescript
flag -
Tailwind: Instantly integrate Tailwind using
--tailwind
flag in your Next.js PWA. -
Prettier: Integrated Prettier to easily format the code with
npm run format
- MIT Licensed: Free to use for personal and commercial use.
Note: If you are on Windows, make sure to either use Command Prompt or Windows Powershell to run the CLI.
📦 Installation
# install the CLI globally
npm i -g create-next-pwa
# use it with npx (recommended)
npx create-next-pwa [app_name]
🚀 Usage
Navigate to the folder you want to have your Next.js PWA.
# using npx
npx create-next-pwa@latest [app_name]
# if you have installed globally
create-next-pwa [app_name]
# to use Next.js with Typescript
create-next-pwa [app_name] --typescript
# Next.js PWA with tailwind integration using npx
npx create-next-pwa@latest [app_name] --tailwind
# Next.js PWA with tailwind integration if you have globally installed the CLI
create-next-pwa [app_name] --tailwind
# without giving app name in terminal using npx
npx create-next-pwa@latest
# without giving app name in terminal using npx and tailwind integration
npx create-next-pwa@latest --tailwind
# without giving app name in terminal if installed globally
create-next-pwa
# without giving app name in terminal if install globally along with tailwind integration
create-next-pwa --tailwind
🎩 Demo
# using npx
npx create-next-pwa [app_name]
# integrate tailwind in the Next.js PWA
npx create-next-pwa [app_name] --tailwind
# if you have installed globally
create-next-pwa [app_name]
# you can also just use the create-next-pwa command
create-next-pwa
👨🏻💻 Contributing
Make sure you read the contributing guidelines before opening a PR. If you want something else to integrate with the CLI like I have done with tailwind, open an issue in the repository and I will get back to it.
⚡️ Other Projects
I have curated a detailed list of all the open-source projects I have authored. Do take out a moment and take a look.
🔑 License & Conduct
- MIT © Saad Irfan
- Code of Conduct