CATALOG.md: build command library (fix #1166) (PR #1178)

This commit is contained in:
deciacco 2021-05-03 19:08:32 +02:00 committed by GitHub
parent 6cf533c5ac
commit d6f0a28a90
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 43 additions and 0 deletions

37
CATALOG.md Normal file
View File

@ -0,0 +1,37 @@
# Build Commands Catalog
Below you'll find a list of build commands contributed by the Nativefier community. They are here as examples, and to help you nativefy "complicated" apps that ask a bit of elbow grease to work.
- Only add sites that require something special! No need to document here that `simplesite.com` works with a simple `nativefier simplesite.com` 🙂
- If you'd like to add to this catalog, please add commands with the *strict necessary* to make an app work. So, for example,
- Yes to have `--widevine` in Udemy. Yes to `--internal-urls` and `--browserwindow-options` for Outlook Web. Yes to a name and icon for both...
- ... but let's not have all the other flags that are a matter of personal preference (e.g. `--disable-dev-tools` or `--disk-cache-size`).
* * *
## Outlook Web
```
nativefier https://outlook.office.com/mail
--internal-urls ".*?(outlook.live.com|outlook.office365.com|outlook.office.com).*?"
--file-download-options "{\"saveAs\": true}"
--browserwindow-options "{ \"webPreferences\": { \"webviewTag\": true, \"nodeIntegration\": true, \"nodeIntegrationInSubFrames\": true, \"nativeWindowOpen\": true } }"
```
### Notes
`--browserwindow-options` -- This is needed in order to allow the window to pop out when creating/editing an email.
## Udemy
```
nativefier https://www.udemy.com/
--internal-urls ".*?udemy.*?"
--file-download-options "{\"saveAs\": true}"
--widevine
```
### Notes
Most videos will work, but to be sure everything works you are better off using the `--widevine` version AND signing the app afterwards. See this post: [#1147 (comment)](https://github.com/nativefier/nativefier/issues/1147#issuecomment-828750362)

View File

@ -57,6 +57,10 @@ to learn about other command-line flags usable to configure the packaged app.
To have high-resolution icons used by default for an app/domain, please
contribute to the [icon repository](https://github.com/nativefier/nativefier-icons)!
### Build Commands Catalog
For a list of build commands contributed by the nativefier community take a look at the [CATALOG.md file](CATALOG.md)
## Usage with Docker
Nativefier is also usable from Docker.
@ -93,6 +97,8 @@ Help welcome on [bugs](https://github.com/nativefier/nativefier/issues?q=is%3Aop
Before submitting a question or bug report, please ensure you have read through these common issues and see if you can resolve the problem on your own. If you still encounter issues after trying these steps, or you don't see something similar to your issue listed, please submit a [bug report](https://github.com/nativefier/nativefier/issues/new?assignees=&labels=bug&template=bug_report.md).
Take a look a the [Build Command Catalog](CATALOG.md) as a working command for your application may already exist there.
### I am trying to use Nativefier to build an app for a site that tells me I have an old/unsupported browser.
This issue comes up for sites that do not wish to support an app made with Nativefier or similar technologies (such as [Google](https://github.com/nativefier/nativefier/issues/831) and [WhatsApp](https://github.com/nativefier/nativefier/issues/1112))