Skip to content

A simple script to convert static websites into Progressive Web Apps.

License

Notifications You must be signed in to change notification settings

callmeahmedr/pwa-converter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PWA Converter

PWA Converter

A simple script to convert your websites into Progressive Web Apps.

It's an open source project, if you find any bugs feel free to open up an issue here on github and you can always contribute if you want to

How to Use

  1. Clone the repository into your project:

    git clone https://github.com/callmeahmedr/pwa-converter.git
  2. Copy the pwa/ folder and service-worker.js into your website's root directory.

  3. Add the following script tag to your HTML file(s):

    <script src="/pwa/pwa.js"></script>
  4. Customize the manifest.json file and icons in the pwa/ folder as needed.

Customizing the Manifest

The manifest.json file can be customized to match your website's branding and requirements:

  • name: Full name of your app.
  • short_name: A shorter version of the name.
  • start_url: The entry point for your app.
  • display: How the app is displayed (e.g., standalone, fullscreen).
  • background_color: The background color for the splash screen.
  • theme_color: The color of the app's title bar.

Replace the default icons with your own by adding them to the icons/ directory and updating the paths in manifest.json.

Deployment

To deploy your PWA:

  1. Make sure the pwa/ folder is in your website's root directory.
  2. Remember that the service-worker.js should be in your website's root directory
  3. Add the script tag to your HTML.
  4. The PWA will now work on your site!

License

This project is licensed under the MIT License.

Happy Coding ❤️

About

A simple script to convert static websites into Progressive Web Apps.

Resources

License

Stars

Watchers

Forks

Packages

No packages published