Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samuelmaddock/electron-browser-shell
A minimal, tabbed web browser with support for Chrome extensions—built on Electron.
https://github.com/samuelmaddock/electron-browser-shell
browser chrome-extension electron
Last synced: 24 days ago
JSON representation
A minimal, tabbed web browser with support for Chrome extensions—built on Electron.
- Host: GitHub
- URL: https://github.com/samuelmaddock/electron-browser-shell
- Owner: samuelmaddock
- License: gpl-3.0
- Created: 2020-03-07T07:52:41.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-28T16:12:01.000Z (about 1 month ago)
- Last Synced: 2024-10-09T18:32:59.584Z (25 days ago)
- Topics: browser, chrome-extension, electron
- Language: TypeScript
- Homepage:
- Size: 1.79 MB
- Stars: 359
- Watchers: 11
- Forks: 72
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-github-star - electron-browser-shell
README
# electron-browser-shell
A minimal, tabbed web browser with support for Chrome extensions—built on Electron.
## Packages
| Name | Description |
| --- | --- |
| [shell](./packages/shell) | A minimal, tabbed web browser used as a testbed for development of Chrome extension support. |
| [electron-chrome-extensions](./packages/electron-chrome-extensions) | Adds additional API support for Chrome extensions to Electron. |
| [electron-chrome-context-menu](./packages/electron-chrome-context-menu) | Chrome context menu for Electron browsers. |
## Usage
```bash
# Get the code
git clone [email protected]:samuelmaddock/electron-browser-shell.git
cd electron-browser-shell
# Install and launch the browser
yarn
yarn start
```
### Install extensions
Load unpacked extensions into `./extensions` then launch the browser.
## Roadmap
### 🚀 Current
- [x] Browser tabs
- [x] Unpacked extension loader
- [x] Initial [`chrome.tabs` extensions API](https://developer.chrome.com/extensions/tabs)
- [x] Initial [extension popup](https://developer.chrome.com/extensions/browserAction) support
- [ ] Support for common [`chrome.*` extension APIs](https://developer.chrome.com/extensions/devguide)
- [ ] Robust extension popup support
- [ ] [Manifest V3](https://developer.chrome.com/docs/extensions/mv3/intro/) support
- [ ] Respect extension manifest permissions
### 🤞 Eventually
- [ ] Extension management (enable/disable/uninstall)
- [ ] .CRX extension loader
- [ ] Installation prompt UX
- [ ] [Chrome Web Store](https://chrome.google.com/webstore) extension installer
- [ ] [Microsoft Edge Add-ons](https://microsoftedge.microsoft.com/addons/Microsoft-Edge-Extensions-Home) extension installer
- [ ] Automatic extension updates
- [ ] Full support of [`chrome.*` extension APIs](https://developer.chrome.com/extensions/devguide)
### 🤔 Considering
- [ ] Opt-in support for custom `webRequest` blocking implementation
- [ ] Browser tab discarding
### ❌ Not planned
- [Chrome Platform App APIs](https://developer.chrome.com/docs/extensions/reference/#platform_apps_apis)
## License
GPL-3
For proprietary use, please [contact me](mailto:[email protected]?subject=electron-browser-shell%20license) or [sponsor me on GitHub](https://github.com/sponsors/samuelmaddock/) under the appropriate tier to [acquire a proprietary-use license](https://github.com/samuelmaddock/electron-browser-shell/blob/master/LICENSE-PATRON.md). These contributions help make development and maintenance of this project more sustainable and show appreciation for the work thus far.
### Contributor license agreement
By sending a pull request, you hereby grant to owners and users of the
electron-browser-shell project a perpetual, worldwide, non-exclusive,
no-charge, royalty-free, irrevocable copyright license to reproduce, prepare
derivative works of, publicly display, publicly perform, sublicense, and
distribute your contributions and such derivative works.
The owners of the electron-browser-shell project will also be granted the right to relicense the
contributed source code and its derivative works.