Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cheap-glitch/warpgate

💫 A lightweight browser extension to jump to various external bookmarks from the address bar.
https://github.com/cheap-glitch/warpgate

browser-extension firefox-addon firefox-extension firefox-webextension github-stars web-extension

Last synced: 3 months ago
JSON representation

💫 A lightweight browser extension to jump to various external bookmarks from the address bar.

Awesome Lists containing this project

README 

        



![Logo (light mode)](docs/logo-dark.png#gh-light-mode-only)

![Logo (dark mode)](docs/logo-light.png#gh-dark-mode-only)



[![License](https://shields.io/github/license/cheap-glitch/warpgate?color=ff3acc)](LICENSE)

[![Latest release](https://shields.io/github/v/release/cheap-glitch/warpgate?sort=semver&label=latest%20release&color=ff3acc)](https://github.com/cheap-glitch/warpgate/releases/latest)






**Warpgate** is  a browser extension which  enables a quick and  painless way to

access "external bookmarks", i.e.  URLs that have been pinned/starred/bookmarked

in a third-party service or web app.



> For now, Warpgate only works  with starred GitHub repos. Suggestions for other

> services are welcomed!



## Installation



 * [Firefox](https://addons.mozilla.org/en-US/firefox/addon/warpgate)

 * Chrome (not yet available)

 * Opera (not yet available)



### Configuration



Go the preferences  page (`about:addons` > *Warpgate* >  *Preferences*) to setup

the extension.



#### Starred GitHub repos



Create a new personal token by going to [this page](https://github.com/settings/tokens/new?description=Warpgate&scopes=read:user)

and clicking  on **Generate token**  at the bottom. Copy-paste  the alphanumeric

code in the corresponding field, wait for  the targets to update, and that's it!



You can  now jump  to any  of your  starred GitHub  repos. The  suggestions will

update themselves when you unstar a repo or star a new one.



## Usage



Enter the  prefix `@` in  the address  bar, followed by  a space and  the search

string. Warpgate will suggest matching targets based on your settings.



![usage demo](docs/demo.gif)



The warp targets are  updated every 10 minutes, but if for  some reason you want

an immediate refresh, press `Alt + W` on your keyboard.



## F.A.Q.



### What are the required permissions for?



The **storage** permission is  needed to keep the list of  URLs in the browser's

long-term memory  and avoid  flooding third-party  services with  requests every

time you enter something in the address bar.



The **notifications**  is needed  to, well, send  notifications. It's  only used

once, when  the local  data is forcefully  refreshed by pressing  `Alt +  W`, to

notify of the success of the operation.



### What about things like saved  Reddit posts, Pocket items, tweet collections, etc?



Those URLs are more akin to archived files: they're saved for a potential use at

an  unknown later  point, not  for regular  visits. Warpgate  focuses on  giving

instant access  to more frequently visited  URLs which are closer  to in-browser

bookmarks.



## Contributing



Contributions are welcomed! Please open an issue before submitting substantial changes.



## Acknowledgments



The  font used  for the  logo is  [VAL](https://www.fontfabric.com/fonts/val) by

[FontFabric](https://www.fontfabric.com).



## License



[Mozilla Public License 2.0](https://www.mozilla.org/en-US/MPL/2.0)