Skip to content

The fastest access to your favorite applications.

License

Notifications You must be signed in to change notification settings

AndrianBalanescu/Shuttle

 
 

Repository files navigation


Shuttle

The fastest access to your favorite applications.

Installation

Shuttle's last stable version can be downloaded from either our website or GitHub releases.

Working on Microsoft Windows (7+), GNU/Linux Debian (Xfce and Mate) and MacOS (1.9+). Not deployed on MacOS

Using git

# clone the repository
$ git clone https://github.com/ShuttleBrowser/Shuttle.git

# change the working directory to shuttle
$ cd Shuttle

# install the requirements
$ npm install

Note: Node 10.11.0 or higher is required.

Getting Started

You can now help us by translating Shuttle !

On Windows, Shuttle can be launched by clicking on its shortcut which can be found directly on the desktop or from the Start menu. The program should then start in the notification center. Its icon can be found in the system tray, at the bottom right of the screen. Clicking on its icon will show Shuttle's main window.

In order to add a new website (we refer to them as "bookmarks") just click on the "plus" (+) button. A dialog will open to ask you for the URL of the website you want to add. Enter it and validate to see a new icon being added to the bookmarks bar. You can now click on this icon at any time to display the website.

A bookmark can be deleted by right-clicking on its icon.

The settings can be edited by clicking on the gear. They make possible to manage your preferences by offering, for instance, to launch Shuttle on boot or to force Shuttle to stay opened.

All updates are automatic and new versions are checked at the launch of the application. You can also search for updates by clicking on the arrows below the settings. If you need help to setup or use Shuttle, or you want to report a bug, please contact us at [email protected].

Stay in touch by joining us on Twitter or Discord.

Keyboard shortcuts

Currently in developement.

  • Add bookmark : Ctrl P
  • Remove bookmark : Ctrl R
  • Show home page: Ctrl H
  • Show settings : Ctrl S
  • Open quicksearch : Ctrl K
  • Take screenshot : Ctrl Shift S
  • Show/Hide Shuttle : Ctrl Alt X
  • Refresh page : F5
  • Go back in history Alt
  • Go forward in history Alt
  • Open website dev tools Ctrl Shift I
  • Open Shuttle dev tools Ctrl Alt I

Note: the Ctrl key is replaced by Cmd key on MacOs.

Storage

Shuttle stores informations about your current bookmarks in a JSON file:

{
  "bookmarks": [
    {
      "id": 1,
      "type": "website",
      "url": "https://google.com",
      "icon": "https://api.faviconkit.com/google.com/144",
      "order": 1
    },
    {
      "id": 2,
      "type": "website",
      "url": "https://intagram.com",
      "icon": "https://api.faviconkit.com/intagram.com/144",
      "order": 2
    },
    {
      "id": 3,
      "type": "website",
      "url": "https://twitter.com",
      "icon": "https://api.faviconkit.com/twitter.com/144",
      "order": 3
    }
  ]
}

Built With

Authors

Currently maintained by robjullian, KazeJiyu, Vahelnir and TheRolf.

See also the list of contributors who participated in this project.

License

This project is licensed under the NPOSL 3.0 License.
The logo and all associated visuals are under the CC BY-NC-ND 3.0 License.

Current Version

About

The fastest access to your favorite applications.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 62.5%
  • HTML 21.5%
  • CSS 16.0%