Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 2.83 KB

README.md

File metadata and controls

82 lines (53 loc) · 2.83 KB

Excalith Start Page

This is an interactive start age for browsers, inspired from my terminal setup.

Vercel Status GitHub Version (latest semver) Docker Version (latest semver)

Demo

Online

You can check the working version from here

Docker

From Docker Registry

docker pull excalith/start-page:latest

From GitHub Registry

docker pull ghcr.io/excalith/excalith-start-page:latest

Start Container

# You can change the port mapping of 8080 into something you want
docker run --name start-page --restart=always -p 8080:3000 -d excalith/start-page

Local

Clone this repo and run yarn dev command to host it locally on your machine

Features

  • Quickly filter links by typing in the prompt. Hitting Enter will open all filtered links at once
  • If nothing filtered, the text in prompt will use the default search engine for searching your input
  • Launch websites directly from the prompt. Just type the URL (ie. github.com)
  • Search websites with custom commands. For example, type s some weird bug to search StackOverflow for some weird bug
  • Multiple ways to customize the start page to your liking

Built-In Commands

  • Show usage with help command (shows basic usage and your configured search shortcuts)
  • Show info with fetch command (time, date, system and browser data)
  • Update your configuration with config command
    • config import <url> - Import configuration from a URL to your local storage
    • config edit - Edit local configuration within editor
    • config reset - Reset your configuration to default

Key Bindings

  • Clear the prompt quickly with CTRL + C
  • Close window with ESC

Customization

There are multiple ways of customizing the start page to making it yours!

  • Use config edit to edit your configuration within the start page code editor
  • Use config import <url> to import configuration from a URL
  • Change the default configuration in startpage.config.js file and deploy your own version

Please refer to wiki page for more information.

How To Contribute

Please feel free to contribute any way you can. Just keep in mind that you should pay attention to contributing guideline before contributing.

License

The code is available under the MIT license.