khairul169/honey
1
0
Fork 0
mirror of https://github.com/khairul169/honey.git synced 2025-05-14 22:59:30 +07:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update READMEs

Browse Source
This commit is contained in:
Daniel 2023-10-15 00:38:19 +02:00
parent 413699ff56
commit f9a2d13f0a
2 changed files with 55 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
README.md
View File

@ -4,35 +4,42 @@ A sweet dashboard hosted on my homeserver with some self-hosted stuff...
<img src="screenshot.jpg" style="width: 720px">
Please also check the **[Live demo](https://dani3l0.github.io/honey)**!
## Installation
# Installation
Works out of the box. Just put those files at the webroot of your server and then tweak the `config.json` file located in `config` directory!
It's extremely easy. honey is built in mind of simplicity.
honey is written in **pure** `HTML` `CSS` `JS` so dynamic backend is not required. All operations are done client-side.
1. Please **go to [Releases](https://github.com/dani3l0/honey/releases) and download latest archive** with prebuilt assets (not the source code).
2. Extract downloaded archive to your webserver root.
3. You're done!
4. Also, don't forget about [configuration](#configuration)!
**Note:** honey is written in **pure** `HTML` `CSS` `JS` so dynamic backend or special webserver configuration is not required. All operations are done client-side.
## Configuration
Default `config.json` file is pretty readable, so you shouldn't have trouble with customizing it.
Configuration file is located at `config/config.json`. It is pretty readable, so you shouldn't have trouble customizing it.
### Tweaking the user interface
The following keys are available under `ui` section
The following keys are available under `ui` section. Some of them are listed in _Settings_ page and can be overriden by end-user.
| Key name | Description |
|--------------------|-------------------------------------------------------------------------------|
| `name` | Name shown at the main screen and the tab title. |
| `desc` | Short description shown under title at the main screen. |
| `icon` | Icon shown at the main screen and as site's favicon. |
| `wallpaper` | Background image visible when dark mode is disabled. |
| `wallpaper_dark` | Background image visible when dark mode is enabled. |
| `dark_mode` | Tells whether dark mode is enabled by default. |
| `open_new_tab` | Tells whether clicking on a service will open it in new tab (by default). |
| `blur` | Tells whether card background blur is enabled by default. |
| `animations` | Tells whether UI animations are enabled by default. |
| `hosted_by` | Short note who's hosting listed services. Visible in `Overview` tab. Settng `null` hides it. |
| Key name | Description | in Settings |
|-----------------------|---------------------------------------------------------------------------------------|---------------|
| `name` | Name shown at the main screen and the tab title. | ❌ |
| `desc` | Short description shown under title at the main screen. | ❌ |
| `icon` | Icon shown at the main screen and as site's favicon. | ❌ |
| `wallpaper` | Background image visible when dark mode is disabled. | ❌ |
| `wallpaper_dark` | Background image visible when dark mode is enabled. | ❌ |
| `dark_mode` | Tells whether dark mode is enabled by default. | ✅ |
| `open_new_tab` | Tells whether clicking on a service will open it in new tab by default. | ✅ |
| `blur` | Tells whether card background blur is enabled by default. | ✅ |
| `animations` | Tells whether UI animations are enabled by default. | ✅ |
### Adding custom services
@ -45,3 +52,32 @@ The following keys are available under `ui` section
| `desc` | Short description shown under service's name. |
| `href` | HTTP address of your service. It is directly passed to `<a>` tag. |
| `icon` | Path to an icon of your service. |
## Development
honey is built on top of [Vite.js](https://vitejs.dev/). This tool allows for faster development and offers various code optimizations.
Before proceeding, make sure you have all the requirements installed:
```
npm i
```
### Live server
This will spin up a HTTP server on [localhost:5173](http://localhost:5173/) and after each file write, UI will be automatically reloaded so there is no need to `ALT`+`TAB` to check the results.
```
npm run dev
```
### Build
This command will link and optimize project assets to take less space and require less bandwith. Optimized assets will be stored in `dist` directory.
```
npm run build
```

3
public/config/config.json
View File

@ -8,8 +8,7 @@
"dark_mode": false,
"open_new_tab": false,
"blur": true,
"animations": true,
"hosted_by": "somebody"
"animations": true
},
"services": [
{