https://github.com/callmeahmedr/pwa-converter

A simple script to convert static websites into Progressive Web Apps.
https://github.com/callmeahmedr/pwa-converter

Last synced: 28 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/callmeahmedr/pwa-converter
• Owner: callmeahmedr
• License: mit
• Created: 2024-08-27T15:47:07.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-09-13T18:56:14.000Z (about 2 months ago)
• Last Synced: 2024-09-14T09:51:32.796Z (about 2 months ago)
• Language: JavaScript
• Size: 114 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![PWA Converter](https://raw.githubusercontent.com/callmeahmedr/pwa-converter/main/tmp/pwa-converter.png)

# 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:

    ```bash

    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):

    ```html

    

    ```

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 ❤️