the-glorious-startpage/README.md

a modern looking startpage

A feature-rich modern-looking startpage and pretty much work in progress

Live Preview

Gallery

Searchbar	Settings

Web Menu	Weather Forecast

It looks good on mobile too

Searchbar	Settings

Web Menu	Weather Forecast

Features

• Responsive UI
• Web search Suggestions
• Mobile Support with Swipe Gestures
• Theme Settings - Change colors on-the-fly
• Weather Forecast - OpenWeatherMap
• Search engine selection
• Dynamic Background
• Web menu with Fuzzy Search
• Keyboard Navigation
• Pure Javascript!
• And many bugs!

Keybindings

• alt + S - toggles dashboard
• alt + E - toggles web menu
• alt + X - toggles weather screen
• Escape - close panels/toggles web menu
• Backspace - toggles search box

Swipe gestures

• swipe right - opens web menu
• swipe left - opens dashboard
• swipe up - opens weather screen
• swipe down - opens search box

Customization and Settings

Changing the colors and blur strength on-the-fly

• Open the dashboard by clicking the settings button on the dock.
• Change the color and blur strength by setting it on the Theme Engine section.
• Supports #RGB, #RRGGBBAA, and #RRGGBB.

Adding more buttons on the web menu

Add more buttons or web shortcuts in web menu by editing the webSites array in js/config.js. Make sure to put an icon with svg format for the shortcut in assets/webcons/ folder.

let webSites = [
	{
		site: 'Reddit',
		icon: 'reddit',
		url: 'https://reddit.com/',
		category: 'social'
	},
	...
]

Adding more buttons on the dock

To add more web shortcuts/buttons in the dock, you have to edit the dockSites array in js/config.js. Make sure to put an icon with svg format for the shortcut in assets/webcons/ folder.

let dockSites = [
	{
		site: 'Reddit',
		icon: 'reddit',
		url: 'https://reddit.com/'
	},
	...
]

Set your OpenWeatherMap API key

Setting your OpenWeatherMap credential is a breeze.

• If you don't have an API key, follow this guide:

  How to get a credentials for the weather forecast?

  • OpenWeatherMap is the weather provider, so go to OpenWeatherMap's website.
  • Register, log-in, and then go here to generate your very own API keys.

• After getting you API key, you have to get your City ID.

• Put your API key and City ID in the Weather Settings.

• Apply.

Changing the default search engine

Google is the default search engine of the search bar, if you want to change it DuckDuckGo or something:

• Open the dashboard by clicking the settings button on the dock.
• Find the Search Engine section and select your preferred search engine.
• Set it as default.

Changing the profile picture

• Replace the user.png image file in /assets/.

Changing the background image

The background image changes based on time.

• Change the background images in assets/backgrounds/.
• Make sure that it is in webp format.
• A lower resolution of each images are also required.

Keybindings

• You can add, replace, or remove a keybinding by editing js/keybindings.js.

Important Note

• If you're using firefox and blur effect is not enabled, open about:config, accept the risks, find layout.css.backdrop-filter.enabled set it to true to enable it. Refresh the startpage.

• The code could be better, this is my first time writing a startpage from the ground up. I will improve this from time to time.

• Found a bug, error or do you have a suggestion? Feel free to open an issue or pull request.

• Tested only on Firefox and Google Chrome.

TODO

• GUI Settings
• Weather Forecast
• Dynamic Background
• Cleaner code^WIP
• Keyboard navigation
• Swipe gestures for mobile

License

Feel free to use or modify this however you like!