mirror of https://github.com/jiahaog/Nativefier
Get rid of "docs" folder (#1194)
It contains a weird mix of stuff and hides valuable files from view at the root of the repo. Better to have: - Docs at the root - Rest of the github/release-related hodgepodge (screenshots, scripts) in hidden folder .github
This commit is contained in:
parent
1a810e5ce5
commit
cc02b87de7
|
@ -15,7 +15,7 @@ Incomprehensible / incomplete bug reports will be closed.
|
||||||
|
|
||||||
**Homework**
|
**Homework**
|
||||||
|
|
||||||
- [ ] I looked at `nativefier --help` and https://github.com/nativefier/nativefier/blob/master/docs/api.md
|
- [ ] I looked at `nativefier --help` and https://github.com/nativefier/nativefier/blob/master/API.md
|
||||||
- [ ] I checked the [Troubleshooting section of the README](https://github.com/nativefier/nativefier/blob/master/README.md#troubleshooting).
|
- [ ] I checked the [Troubleshooting section of the README](https://github.com/nativefier/nativefier/blob/master/README.md#troubleshooting).
|
||||||
- [ ] I searched existing issues, open & closed. Yes, my bug is new.
|
- [ ] I searched existing issues, open & closed. Yes, my bug is new.
|
||||||
- [ ] I'm using the latest version available at https://github.com/nativefier/nativefier/releases
|
- [ ] I'm using the latest version available at https://github.com/nativefier/nativefier/releases
|
||||||
|
|
|
@ -15,7 +15,7 @@ Incomprehensible / incomplete feature requests will be closed.
|
||||||
|
|
||||||
**Homework**
|
**Homework**
|
||||||
|
|
||||||
- [ ] I looked at `nativefier --help` and https://github.com/nativefier/nativefier/blob/master/docs/api.md , no existing option fits my needs.
|
- [ ] I looked at `nativefier --help` and https://github.com/nativefier/nativefier/blob/master/API.md , no existing option fits my needs.
|
||||||
- [ ] I searched existing issues, open & closed. Yes, my feature request is new.
|
- [ ] I searched existing issues, open & closed. Yes, my feature request is new.
|
||||||
- [ ] I'm using the latest version available at https://github.com/nativefier/nativefier/releases
|
- [ ] I'm using the latest version available at https://github.com/nativefier/nativefier/releases
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,7 @@ Incomprehensible / incomplete questions will be closed.
|
||||||
|
|
||||||
**Homework**
|
**Homework**
|
||||||
|
|
||||||
- [ ] I looked at `nativefier --help` and https://github.com/nativefier/nativefier/blob/master/docs/api.md
|
- [ ] I looked at `nativefier --help` and https://github.com/nativefier/nativefier/blob/master/API.md
|
||||||
- [ ] I searched existing issues, open & closed. Yes, my question is new.
|
- [ ] I searched existing issues, open & closed. Yes, my question is new.
|
||||||
- [ ] I'm using the latest version available at https://github.com/nativefier/nativefier/releases
|
- [ ] I'm using the latest version available at https://github.com/nativefier/nativefier/releases
|
||||||
|
|
||||||
|
|
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 25 KiB |
|
@ -4,7 +4,7 @@
|
||||||
# Will also create a commit with these changes locally
|
# Will also create a commit with these changes locally
|
||||||
#
|
#
|
||||||
# Usage:
|
# Usage:
|
||||||
# ./generate-changelog -- "7.0.0"
|
# ./.github/generate-changelog -- "7.0.0"
|
||||||
#
|
#
|
||||||
# Prerequisites:
|
# Prerequisites:
|
||||||
# - On master branch
|
# - On master branch
|
Before Width: | Height: | Size: 1.9 MiB After Width: | Height: | Size: 1.9 MiB |
|
@ -65,7 +65,7 @@ nativefier 'https://open.spotify.com/'
|
||||||
|
|
||||||
Notes:
|
Notes:
|
||||||
|
|
||||||
- [Inject](https://github.com/nativefier/nativefier/blob/master/docs/api.md#inject) the following javascript as `spotify.js` to prevent "Unsupported Browser" messages.
|
- [Inject](https://github.com/nativefier/nativefier/blob/master/API.md#inject) the following javascript as `spotify.js` to prevent "Unsupported Browser" messages.
|
||||||
```javascript
|
```javascript
|
||||||
function dontShowBrowserNoticePage() {
|
function dontShowBrowserNoticePage() {
|
||||||
const browserNotice = document.getElementById('browser-support-notice');
|
const browserNotice = document.getElementById('browser-support-notice');
|
||||||
|
@ -114,8 +114,8 @@ if (document.readyState === "interactive") {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
- It is also required to [sign the app](https://github.com/nativefier/nativefier/blob/master/docs/api.md#widevine), or many songs will not play.
|
- It is also required to [sign the app](https://github.com/nativefier/nativefier/blob/master/API.md#widevine), or many songs will not play.
|
||||||
- To hide all download links (as if you were in the actual app), [inject](https://github.com/nativefier/nativefier/blob/master/docs/api.md#inject) the following CSS as `spotify.css`:
|
- To hide all download links (as if you were in the actual app), [inject](https://github.com/nativefier/nativefier/blob/master/API.md#inject) the following CSS as `spotify.css`:
|
||||||
```css
|
```css
|
||||||
a[href="/download"] { display: none; }
|
a[href="/download"] { display: none; }
|
||||||
```
|
```
|
||||||
|
|
10
CHANGELOG.md
10
CHANGELOG.md
|
@ -37,10 +37,10 @@ with a special shoutout to @TheCleric for a mountain of awesome work.
|
||||||
|
|
||||||
Features! (nothing breaking)
|
Features! (nothing breaking)
|
||||||
|
|
||||||
* Add a [`--upgrade`](https://github.com/nativefier/nativefier/blob/master/docs/api.md#upgrade) option to easily upgrade an existing app (fix #1131) (PR #1138)
|
* Add a [`--upgrade`](https://github.com/nativefier/nativefier/blob/master/API.md#upgrade) option to easily upgrade an existing app (fix #1131) (PR #1138)
|
||||||
* Support defining a custom [`--bookmarks-menu`](https://github.com/nativefier/nativefier/blob/master/docs/api.md#bookmarks-menu) (fix #1065) (PR #1155)
|
* Support defining a custom [`--bookmarks-menu`](https://github.com/nativefier/nativefier/blob/master/API.md#bookmarks-menu) (fix #1065) (PR #1155)
|
||||||
* Support setting apps [`--lang`](https://github.com/nativefier/nativefier/blob/master/docs/api.md#lang)uage (fix #175) (PR #1173)
|
* Support setting apps [`--lang`](https://github.com/nativefier/nativefier/blob/master/API.md#lang)uage (fix #175) (PR #1173)
|
||||||
* Support creating self-contained "[`--portable`](https://github.com/nativefier/nativefier/blob/master/docs/api.md#portable)" apps writing their app data to the app folder (fix #376) (PR #1168)
|
* Support creating self-contained "[`--portable`](https://github.com/nativefier/nativefier/blob/master/API.md#portable)" apps writing their app data to the app folder (fix #376) (PR #1168)
|
||||||
* Support opening URLs passed as arg to Nativefied apps (fix #405) (PR #1154)
|
* Support opening URLs passed as arg to Nativefied apps (fix #405) (PR #1154)
|
||||||
|
|
||||||
Bugfixes!
|
Bugfixes!
|
||||||
|
@ -166,7 +166,7 @@ This release includes several contributor patches. Thanks @sorhtyre @mattruzzi !
|
||||||
|
|
||||||
* **[BREAKING CHANGE] Warn on old Electron/Chrome (fix #556) (PR #1076)**
|
* **[BREAKING CHANGE] Warn on old Electron/Chrome (fix #556) (PR #1076)**
|
||||||
⚠️ Users packaging kiosk apps running for a long time on internal websites,
|
⚠️ Users packaging kiosk apps running for a long time on internal websites,
|
||||||
see https://github.com/nativefier/nativefier/blob/master/docs/api.md#disable-old-build-warning-yesiknowitisinsecure
|
see https://github.com/nativefier/nativefier/blob/master/API.md#disable-old-build-warning-yesiknowitisinsecure
|
||||||
* Check for improperly-formatted arguments (fix #885) (PR #1080)
|
* Check for improperly-formatted arguments (fix #885) (PR #1080)
|
||||||
* Correctly start in tray when both `--maximize` and `--tray start-in-tray` are passed (fix #1015) (PR #1079)
|
* Correctly start in tray when both `--maximize` and `--tray start-in-tray` are passed (fix #1015) (PR #1079)
|
||||||
* Fix icon path error when passing asar `--conceal` flag (fix #975) (PR #1074)
|
* Fix icon path error when passing asar `--conceal` flag (fix #975) (PR #1074)
|
||||||
|
|
16
README.md
16
README.md
|
@ -1,6 +1,6 @@
|
||||||
# Nativefier
|
# Nativefier
|
||||||
|
|
||||||
![Example of Nativefier app in the macOS dock](docs/dock.png)
|
![Example of Nativefier app in the macOS dock](.github/dock-screenshot.png)
|
||||||
|
|
||||||
You want to make a native wrapper for WhatsApp Web (or any web page).
|
You want to make a native wrapper for WhatsApp Web (or any web page).
|
||||||
|
|
||||||
|
@ -8,7 +8,7 @@ You want to make a native wrapper for WhatsApp Web (or any web page).
|
||||||
nativefier 'web.whatsapp.com'
|
nativefier 'web.whatsapp.com'
|
||||||
```
|
```
|
||||||
|
|
||||||
![Walkthrough animation](docs/walkthrough.gif)
|
![Walkthrough animation](.github/nativefier-walkthrough.gif)
|
||||||
|
|
||||||
You're done.
|
You're done.
|
||||||
|
|
||||||
|
@ -25,7 +25,7 @@ through the numerous open tabs when I was using [Facebook Messenger](https://mes
|
||||||
|
|
||||||
- Automatically retrieval of app icon / name.
|
- Automatically retrieval of app icon / name.
|
||||||
- JavaScript and CSS injection.
|
- JavaScript and CSS injection.
|
||||||
- Many more, see the [API docs](docs/api.md) or `nativefier --help`
|
- Many more, see the [API docs](API.md) or `nativefier --help`
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
@ -48,7 +48,7 @@ Nativefier will try to determine the app name, and well as lots of other options
|
||||||
If desired, these options can be overwritten. For example, to override the name,
|
If desired, these options can be overwritten. For example, to override the name,
|
||||||
`nativefier --name 'My Medium App' 'medium.com'`
|
`nativefier --name 'My Medium App' 'medium.com'`
|
||||||
|
|
||||||
**Read the [API documentation](docs/api.md) or run `nativefier --help`**
|
**Read the [API documentation](API.md) or run `nativefier --help`**
|
||||||
to learn about other command-line flags usable to configure the packaged app.
|
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
|
To have high-resolution icons used by default for an app/domain, please
|
||||||
|
@ -83,7 +83,7 @@ docker run --rm -v ~/my-icons-folder/:/src -v $TARGET-PATH:/target nativefier/na
|
||||||
Help welcome on [bugs](https://github.com/nativefier/nativefier/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and
|
Help welcome on [bugs](https://github.com/nativefier/nativefier/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and
|
||||||
[feature requests](https://github.com/nativefier/nativefier/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request).
|
[feature requests](https://github.com/nativefier/nativefier/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request).
|
||||||
|
|
||||||
[Developer / build docs](docs/development.md), [API documentation](docs/api.md),
|
[Developer / build docs](HACKING.md), [API documentation](API.md),
|
||||||
[Changelog](CHANGELOG.md).
|
[Changelog](CHANGELOG.md).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
@ -102,7 +102,7 @@ This issue comes up for sites that do not wish to support an app made with Nativ
|
||||||
|
|
||||||
#### Troubleshooting Steps
|
#### Troubleshooting Steps
|
||||||
|
|
||||||
1. First try setting the [`--user-agent`](https://github.com/nativefier/nativefier/blob/master/docs/api.md#user-agent) to something different. Try using the value you would get at [https://www.whatismybrowser.com/detect/what-is-my-user-agent] and use your current browser's user agent.
|
1. First try setting the [`--user-agent`](https://github.com/nativefier/nativefier/blob/master/API.md#user-agent) to something different. Try using the value you would get at [https://www.whatismybrowser.com/detect/what-is-my-user-agent] and use your current browser's user agent.
|
||||||
2. If this doesn't work, the site (such as WhatsApp) may be using a service worker to analyze the app and detect. You can disable the service worker cache by doing the following, which is a known fix for WhatsApp:
|
2. If this doesn't work, the site (such as WhatsApp) may be using a service worker to analyze the app and detect. You can disable the service worker cache by doing the following, which is a known fix for WhatsApp:
|
||||||
1. Create a javascript file containing the following snippet:
|
1. Create a javascript file containing the following snippet:
|
||||||
```javascript
|
```javascript
|
||||||
|
@ -114,7 +114,7 @@ This issue comes up for sites that do not wish to support an app made with Nativ
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
2. Inject the javascript file into your app when generating it with the [`--inject`](https://github.com/nativefier/nativefier/blob/master/docs/api.md#inject) argument.
|
2. Inject the javascript file into your app when generating it with the [`--inject`](https://github.com/nativefier/nativefier/blob/master/API.md#inject) argument.
|
||||||
|
|
||||||
### I am trying to use Nativefier to build an app for a site with video, but the video won't play.
|
### I am trying to use Nativefier to build an app for a site with video, but the video won't play.
|
||||||
|
|
||||||
|
@ -122,7 +122,7 @@ This issue comes up for certain sites like [HBO Max](https://github.com/nativefi
|
||||||
|
|
||||||
#### Troubleshooting Steps
|
#### Troubleshooting Steps
|
||||||
|
|
||||||
1. First try using the [`--widevine`](https://github.com/nativefier/nativefier/blob/master/docs/api.md#widevine) argument when building the app. This uses the [Castlabs version of Electron](https://github.com/castlabs/electron-releases) which allows the playback of DRM enabled video.
|
1. First try using the [`--widevine`](https://github.com/nativefier/nativefier/blob/master/API.md#widevine) argument when building the app. This uses the [Castlabs version of Electron](https://github.com/castlabs/electron-releases) which allows the playback of DRM enabled video.
|
||||||
2. If this doesn't work, the site may require your app to be signed for `--widevine` to work. See the [Castlabs documentation](https://github.com/castlabs/electron-releases/wiki/EVS) on using their application signing service to sign the application.
|
2. If this doesn't work, the site may require your app to be signed for `--widevine` to work. See the [Castlabs documentation](https://github.com/castlabs/electron-releases/wiki/EVS) on using their application signing service to sign the application.
|
||||||
|
|
||||||
### I am trying different options to Nativefier to experiment with, but noticing that sometimes things cache between rebuilds of my app.
|
### I am trying different options to Nativefier to experiment with, but noticing that sometimes things cache between rebuilds of my app.
|
||||||
|
|
|
@ -35,7 +35,7 @@
|
||||||
"build-app-static": "ncp app/src/static/ app/lib/static/ && ncp app/dist/preload.js app/lib/preload.js && ncp app/dist/preload.js.map app/lib/preload.js.map",
|
"build-app-static": "ncp app/src/static/ app/lib/static/ && ncp app/dist/preload.js app/lib/preload.js && ncp app/dist/preload.js.map app/lib/preload.js.map",
|
||||||
"build": "npm run clean && tsc --build . app && npm run build-app && npm run build-app-static",
|
"build": "npm run clean && tsc --build . app && npm run build-app && npm run build-app-static",
|
||||||
"build:watch": "tsc --build . app --watch",
|
"build:watch": "tsc --build . app --watch",
|
||||||
"changelog": "./docs/generate-changelog",
|
"changelog": "./.github/generate-changelog",
|
||||||
"ci": "npm run lint && npm test",
|
"ci": "npm run lint && npm test",
|
||||||
"clean": "rimraf lib/ app/lib/ app/dist/",
|
"clean": "rimraf lib/ app/lib/ app/dist/",
|
||||||
"clean:full": "rimraf lib/ app/lib/ app/dist/ app/node_modules/ node_modules/",
|
"clean:full": "rimraf lib/ app/lib/ app/dist/ app/node_modules/ node_modules/",
|
||||||
|
@ -45,7 +45,7 @@
|
||||||
"list-outdated-deps": "npm out; cd app && npm out; true",
|
"list-outdated-deps": "npm out; cd app && npm out; true",
|
||||||
"prepare": "cd app && npm install && cd .. && npm run build",
|
"prepare": "cd app && npm install && cd .. && npm run build",
|
||||||
"test:integration": "jest --testRegex '.*integration-test.js'",
|
"test:integration": "jest --testRegex '.*integration-test.js'",
|
||||||
"test:manual": "npm run build && ./docs/manual-test",
|
"test:manual": "npm run build && ./.github/manual-test",
|
||||||
"test:unit": "jest",
|
"test:unit": "jest",
|
||||||
"test:watch": "jest --watch",
|
"test:watch": "jest --watch",
|
||||||
"test:withlog": "LOGLEVEL=trace npm run test",
|
"test:withlog": "LOGLEVEL=trace npm run test",
|
||||||
|
|
|
@ -70,7 +70,7 @@ export function initArgs(argv: string[]): yargs.Argv<any> {
|
||||||
})
|
})
|
||||||
.option('global-shortcuts', {
|
.option('global-shortcuts', {
|
||||||
description:
|
description:
|
||||||
'define global keyboard shortcuts via a JSON file; See https://github.com/nativefier/nativefier/blob/master/docs/api.md#global-shortcuts',
|
'define global keyboard shortcuts via a JSON file; See https://github.com/nativefier/nativefier/blob/master/API.md#global-shortcuts',
|
||||||
normalize: true,
|
normalize: true,
|
||||||
type: 'string',
|
type: 'string',
|
||||||
})
|
})
|
||||||
|
@ -108,7 +108,7 @@ export function initArgs(argv: string[]): yargs.Argv<any> {
|
||||||
.option('portable', {
|
.option('portable', {
|
||||||
default: false,
|
default: false,
|
||||||
description:
|
description:
|
||||||
'make the app store its user data in the app folder; WARNING: see https://github.com/nativefier/nativefier/blob/master/docs/api.md#portable for security risks',
|
'make the app store its user data in the app folder; WARNING: see https://github.com/nativefier/nativefier/blob/master/API.md#portable for security risks',
|
||||||
type: 'boolean',
|
type: 'boolean',
|
||||||
})
|
})
|
||||||
.option('upgrade', {
|
.option('upgrade', {
|
||||||
|
@ -152,14 +152,14 @@ export function initArgs(argv: string[]): yargs.Argv<any> {
|
||||||
})
|
})
|
||||||
.option('bookmarks-menu', {
|
.option('bookmarks-menu', {
|
||||||
description:
|
description:
|
||||||
'create a bookmarks menu (via JSON file); See https://github.com/nativefier/nativefier/blob/master/docs/api.md#bookmarks-menu',
|
'create a bookmarks menu (via JSON file); See https://github.com/nativefier/nativefier/blob/master/API.md#bookmarks-menu',
|
||||||
normalize: true,
|
normalize: true,
|
||||||
type: 'string',
|
type: 'string',
|
||||||
})
|
})
|
||||||
.option('browserwindow-options', {
|
.option('browserwindow-options', {
|
||||||
coerce: parseJson,
|
coerce: parseJson,
|
||||||
description:
|
description:
|
||||||
'override Electron BrowserWindow options (via JSON string); see https://github.com/nativefier/nativefier/blob/master/docs/api.md#browserwindow-options',
|
'override Electron BrowserWindow options (via JSON string); see https://github.com/nativefier/nativefier/blob/master/API.md#browserwindow-options',
|
||||||
type: 'string',
|
type: 'string',
|
||||||
})
|
})
|
||||||
.option('disable-context-menu', {
|
.option('disable-context-menu', {
|
||||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 76 KiB |
Binary file not shown.
Before Width: | Height: | Size: 16 KiB |
|
@ -1,3 +0,0 @@
|
||||||
* {
|
|
||||||
color: blue;
|
|
||||||
}
|
|
|
@ -1,3 +0,0 @@
|
||||||
const log = require('loglevel'); // eslint-disable-line @typescript-eslint/no-var-requires
|
|
||||||
|
|
||||||
log.info('This is a test injecton script');
|
|
Loading…
Reference in New Issue