forked from extern/the-glorious-startpage
readme and scrots
This commit is contained in:
parent
544773515b
commit
bd6ae9eeee
21
LICENSE
Normal file
21
LICENSE
Normal file
@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020 Gerome Matilla
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
81
README.md
Normal file
81
README.md
Normal file
@ -0,0 +1,81 @@
|
||||
## a modern looking startpage
|
||||
[](https://github.com/manilarome/the-glorious-startpage/commits/master) [](https://github.com/manilarome/the-glorious-startpage/pulls) [](http://hits.dwyl.com/manilarome/the-glorious-startpage)
|
||||
|
||||
### A feature-rich modern-looking startpage and pretty much work in progress
|
||||
|
||||
## [Live Preview](https://manilarome.github.io/the-glorious-startpage/)
|
||||
|
||||
## Gallery
|
||||
|
||||
| Searchbar | Settings |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
| Web Menu | Weather Forecast |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
#### It looks good on mobile too
|
||||
|
||||
| Searchbar | Settings |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
| Web Menu | Weather Forecast |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
## Features
|
||||
|
||||
+ Responsive UI
|
||||
+ 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
|
||||
|
||||
+ <kbd>alt + s</kbd> - toggles dashboard
|
||||
+ <kbd>alt + e</kbd> - toggles web menu
|
||||
+ <kbd>alt + x</kbd> - toggles weather screen
|
||||
+ <kbd>Escape</kbd> - close panels/toggles web menu
|
||||
+ <kbd>Backspace</kbd> - toggles search box
|
||||
|
||||
### TODO
|
||||
|
||||
- [x] GUI Settings
|
||||
- [x] Weather Forecast
|
||||
- [x] Dynamic Background
|
||||
- [x] Cleaner code<sup>WIP</sup>
|
||||
- [x] Keyboard navigation
|
||||
- [x] Swipe gestures for mobile
|
||||
|
||||
|
||||
### Important Note
|
||||
|
||||
+ I'm using the `backdrop-filter` property to have the blur effect for the panels. If you're using Firefox, find `layout.css.backdrop-filter.enabled` then enable it.
|
||||
|
||||
+ You can now set your default search engine and OpenWeatherMap credentials using the GUI. It uses the `window.localStorage` so it's completely safe. I also provided a button that will allow you to delete/clear your credentials.
|
||||
|
||||
+ Openweather map API key is not included!
|
||||
|
||||
How to get a credentials for the weather forecast?
|
||||
|
||||
- OpenWeatherMap is the weather provider, so go to OpenWeatherMap's [website](https://home.openweathermap.org/).
|
||||
- Register, log-in, and then go [here](https://home.openweathermap.org/api_keys) to generate your very own API keys.
|
||||
- Put your credentials in the settings in settings panel.
|
||||
|
||||
+ You can easily add a button on the dock and web menu by just adding `website name`, `icon name`, and `website url` in an array. Open `js/sites-list.js`. Make sure to put an icon with `.svg` extension for that website in `assets/webcons/`.
|
||||
|
||||
+ Add your own keyboard bindings in `js/keybindings.js`.
|
||||
|
||||
+ 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.
|
Loading…
Reference in New Issue
Block a user