frappe_pwa

frappe_pwa copied to clipboard

Frappe PWA

:alembic: PWA setup for Frappe website.

:blue_book: Docs

See GitHub Pages at monogramm.github.io/frappe_pwa.

:chart_with_upwards_trend: Changes

All notable changes to this project will be documented in CHANGELOG file. This CHANGELOG is generated with :heart: by gitmoji-changelog.

This project adheres to Semantic Versioning.

:bookmark: Roadmap

See Taiga.io

:construction: Install

Install Frappe application

bench get-app https://github.com/Monogramm/frappe_pwa
bench install-app frappe_pwa

Check Frappe Install for more details.

:white_check_mark: Run tests

bench run-tests --app frappe_pwa

Check Frappe Unit Testing for more details.

When installing Frappe app, the following python requirements will be installed:

:rocket: Usage

How to use this application:

• Setup website Progressive Web Application:
  • Go to "Website App Manifest" and press button "Automatically configure PWA" or go to "Website Settings" and add into "HTML HEADER & ROBOTS" the web app manifest manually: <link rel="manifest" href="/manifest.json">

After setup has been done, just go to /install page and press on install inside pop-up message.

:bust_in_silhouette: Authors

Monogramm

• Website: https://www.monogramm.io
• Github: @Monogramm

AminovE99

• Website: https://aminove99.github.io/
• Github: @AminovE99

:handshake: Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. Check the contributing guide.

:thumbsup: Show your support

Give a :star: if this project helped you!

:page_facing_up: License

Copyright © 2021 Monogramm.
This project is AGPL v3 licensed.

This README was generated with :heart: by readme-md-generator