Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/msaaddev/create-next-pwa
⚡️ Set up Next.js Progressive Web App with `npx create-next-pwa`
https://github.com/msaaddev/create-next-pwa
cli javascript js nextjs nextjs-boilerplate nextjs-pwa node node-cli nodejs progressive-web-app pwa pwa-boilerplate tailwind tailwindcss
Last synced: about 1 month ago
JSON representation
⚡️ Set up Next.js Progressive Web App with `npx create-next-pwa`
- Host: GitHub
- URL: https://github.com/msaaddev/create-next-pwa
- Owner: msaaddev
- License: mit
- Created: 2021-06-04T13:49:31.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-07-25T16:41:07.000Z (over 3 years ago)
- Last Synced: 2024-10-28T16:13:41.056Z (about 2 months ago)
- Topics: cli, javascript, js, nextjs, nextjs-boilerplate, nextjs-pwa, node, node-cli, nodejs, progressive-web-app, pwa, pwa-boilerplate, tailwind, tailwindcss
- Language: JavaScript
- Homepage: https://twitter.com/msaaddev
- Size: 89.5 MB
- Stars: 85
- Watchers: 3
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: license
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
- awesome-tailwindcss - Next.js PWA
README
⚡️ create-next-pwa
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
```sh
# 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.
```sh
# 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
```sh
# using npx
npx create-next-pwa [app_name]
```
```sh
# integrate tailwind in the Next.js PWA
npx create-next-pwa [app_name] --tailwind
```
```sh
# if you have installed globally
create-next-pwa [app_name]
```
```sh
# you can also just use the create-next-pwa command
create-next-pwa
```
## 👨🏻💻 Contributing
Make sure you read the [contributing guidelines](https://github.com/msaaddev/create-next-pwa/blob/master/contributing.md) 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](https://github.com/msaaddev/open-source) of all the open-source projects I have authored. Do take out a moment and take a look.
## 🔑 License & Conduct
- MIT © [Saad Irfan](https://github.com/msaaddev)
- [Code of Conduct](https://github.com/msaaddev/create-next-pwa/blob/master/code-of-conduct.md)