https://github.com/RustyDaemon/homepage-desktop
A simple cross-platform Desktop wrapper over Homepage dashboard.
https://github.com/RustyDaemon/homepage-desktop
Last synced: 11 months ago
JSON representation
A simple cross-platform Desktop wrapper over Homepage dashboard.
- Host: GitHub
- URL: https://github.com/RustyDaemon/homepage-desktop
- Owner: RustamIrzaev
- License: mit
- Created: 2024-03-14T15:44:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-26T15:50:34.000Z (about 2 years ago)
- Last Synced: 2024-03-26T16:28:37.911Z (about 2 years ago)
- Language: TypeScript
- Homepage:
- Size: 220 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# Homepage Desktop
Desktop wrapper for [Homepage dashboard](https://gethomepage.dev/latest/) we all do like. Navigate and open services and bookmarks inside a cozy UI.
On Windows, Linux and Mac.
# Installation
> At this point you have to clone and build the application by yourself. Although, it is quite easy. Binaries are not planned at this moment :/
To do so, you need `Node` to be installed.
1. Clone the repository (or download sources from [Releases](https://github.com/RustamIrzaev/homepage-desktop/releases) and unpack)
2. Navigate to the directory:
3. Run a build script
- Mac/Linux:
```bash
chmod +x ./build.sh
./build.sh
```
- Windows:
```bash
.\build.ps1
```
(if you run into a policy error, run `powershell -ExecutionPolicy Bypass -File .\build.ps1` instead)
4. After the script completes, your application will be under `/build` folder. Feel free to copy anywhere suitable for you and run.
# Configuration
During the first run, the application will ask you to configure a single required parameter - `Homepage dashboard URL`. Specify the url and click 'Save'. Now your application is ready to be used.
## All configuration parameters
| Option | Description | Notes |
| ---------------------- | ------------------------------------------ | ------------------------------- |
| Homepage Dashboard URL | Specify the Homepage url | required |
| Tray Icon | Shows or hides the application tray icon | application restart is required |
| Compact UI | Makes bookmarks and services look the same | - |
# License
Homepage Desktop is released under MIT license. See the [license file](license.md) for more information.