https://github.com/meaghanfitzgerald/nextjs-pwa-boilerplate
The boilerplate code necessary for creating a progressive web application with next.js framework
https://github.com/meaghanfitzgerald/nextjs-pwa-boilerplate
boilerplate manifest-json nestjs-boilerplate next-pwa nextjs nextjs-example nextjs-pwa nextjs-starter nextjs-template nextjs-typescript progressive-web-app progressive-web-apps pwa-boilerplate template templates typescript
Last synced: 2 days ago
JSON representation
The boilerplate code necessary for creating a progressive web application with next.js framework
- Host: GitHub
- URL: https://github.com/meaghanfitzgerald/nextjs-pwa-boilerplate
- Owner: meaghanfitzgerald
- Created: 2023-01-18T21:43:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-18T22:26:41.000Z (over 2 years ago)
- Last Synced: 2025-04-25T18:40:08.566Z (2 months ago)
- Topics: boilerplate, manifest-json, nestjs-boilerplate, next-pwa, nextjs, nextjs-example, nextjs-pwa, nextjs-starter, nextjs-template, nextjs-typescript, progressive-web-app, progressive-web-apps, pwa-boilerplate, template, templates, typescript
- Language: CSS
- Homepage:
- Size: 139 KB
- Stars: 8
- Watchers: 1
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
I created this boilerplate for a Progressive Web Application that uses Next.js framework because many of the tutorials I found online left out important information about options in the `_document.tsx`, `mainfest.json`, and the `next.config.js` files. [This youtube tutorial](https://www.youtube.com/watch?v=ARNN_zmrwcw) had the most up-to-date information at the time, and the comments below were my best resources for creating a PWA with [`next-pwa`](https://www.npmjs.com/package/next-pwa) library and nextjs. Hope this is helpful!
## To Set Up Your Own Progressive Web App with Next.js
Fork this repo, clone to your machine, and when in the root folder, run `npm install`.
If you want to immediately compile and view the boilerplate app on your machine, run:
- `npx next build`
followed by
- `npx next start`
- navigate to `localhost:3000` in your chrome browser (or any browser run with chromium), and view the app.
To import as a desktop app, click the icon seen here:
To customize, edit the provided `manifest.json` file in the `public` folder, and run through the workflow above. Be sure to have the `display` option set to "standalone" or "fullscreen".
Please feel free to leave feedback, comments, or links to issues so that this boilerplate can be kept up-to-date.
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.