https://github.com/tethik/react-ts-mui-mobile-starter
Skeleton for PWA React Web App
https://github.com/tethik/react-ts-mui-mobile-starter
Last synced: about 1 year ago
JSON representation
Skeleton for PWA React Web App
- Host: GitHub
- URL: https://github.com/tethik/react-ts-mui-mobile-starter
- Owner: Tethik
- Created: 2022-09-10T13:36:59.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-04T11:17:35.000Z (about 1 year ago)
- Last Synced: 2025-04-04T12:25:07.582Z (about 1 year ago)
- Language: TypeScript
- Size: 5.51 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# README
Skeleton to set up quick and dirty progessive web apps (PWA).
Uses Typescript, React and MUI.
## Setup
Stuff you should probably change after cloning:
1. `package.json` - change package name, currently used setting the basename for routing stuff and when building (by default set up for github pages)
2. `public/index.html` title, favicon, descriptions etc. See https://vite-pwa-org.netlify.app/guide/pwa-minimal-requirements.html#entry-point
3. `vite.config.ts` for setting your Web App Manifest file.
## Running
`npm run dev` - start the dev server
`npm run build` - build the javascript bundle
### Customizing
* Make logo maskable to ensure you get nice icons when installed: https://web.dev/articles/maskable-icon
* Change `background_color` in manifest.json to match with your icon on the startup splash screen.
## Packaging
The following should work to make into something app-store installable:
https://docs.pwabuilder.com/#/builder/quick-start