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

README: Minor improvements

Browse Source
This commit is contained in:
Daniel 2023-10-25 01:11:31 +02:00
parent b351c2b8d4
commit 9d025428a6
1 changed files with 32 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -2,6 +2,8 @@
A sweet dashboard I use on my homeserver with some self-hosted stuff... A sweet dashboard I use on my homeserver with some self-hosted stuff...
**[📺 Live demo](https://honeyy.vercel.app/)**
<img src="screenshot.jpg" style="width: 720px"> <img src="screenshot.jpg" style="width: 720px">
@ -19,12 +21,13 @@ It works out-of-the-box as all operations are done client-side.
## ⚙️ Configuration ## ⚙️ Configuration
Configuration file is located at `config/config.json`. It is pretty readable, so you shouldn't have trouble customizing it. Also, please don't remove any keys as it will break user interface. Configuration file is located at `config/config.json`.
### 📱 Tweaking the user interface ### 📱 Tweaking the user interface
The following keys are available under `ui` section. Some of them are listed in _Settings_ page and can be overriden by end-user. The following keys are available under `ui` section.
Some of them are listed in _Settings_ page and can be customized by end-user.
| Key name | Description | in Settings | | Key name | Description | in Settings |
|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| |-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------|
@ -37,20 +40,38 @@ The following keys are available under `ui` section. Some of them are listed in
| `open_new_tab` | Tells whether clicking on a service will open it in new tab 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. | ✅ | | `blur` | Tells whether card background blur is enabled by default. | ✅ |
| `animations` | Tells whether UI animations are enabled by default. | ✅ | | `animations` | Tells whether UI animations are enabled by default. | ✅ |
| `https_importance` | How important is HTTPS comparing to independence. If set to `0.25`, HTTPS will score maximum 25% in Privacy Panel. Total importance is `1`. | ✅ | | `https_importance` | How important is HTTPS comparing to independence. If set to `0.25`, HTTPS will score maximum 25% in Privacy Panel. Total importance is `1`. | ❌ |
### 🔗 Adding custom services ### 🔗 Adding custom services
`services` section is an array containing objects. Object's structure looks like this: `services` section is an array containing objects. Object's structure looks like this:
| Key name | Description | | Key name | Description |
|--------------------|-------------------------------------------------------------------------------| |-------------------|-------------------------------------------------------------------------------|
| `name` | Your service's name. | | `name` | Your service's name. |
| `desc` | Short description shown under service's name. | | `desc` | Short description shown under service's name. |
| `href` | HTTP address of your service. It is directly passed to `<a>` tag. | | `href` | URL address of your service. It is directly passed to `<a>` tag. |
| `icon` | Path to an icon of your service. | | `icon` | Path to an icon of your service. |
Example:
```
...
{
"name": "CalDav",
"desc": "Simple CalDav server for calendar sync between various devices.",
"href": "caldav",
"icon": "img/preview/caldav.png"
},
...
```
## 🛡️ Privacy Panel
**How does it work?**
- Checks how many listed services use `HTTPS` for secure connections
- Checks if listed services are on the same origin (like domain, subdomain or IP address), otherwise are considered as third-party
## 🛠️ Development ## 🛠️ Development
@ -67,6 +88,7 @@ git clone https://github.com/dani3l0/honey && cd honey
npm i npm i
``` ```
### 🗼 Live server ### 🗼 Live server
**For coding.** This will spin up a HTTP server on **[localhost:5173](http://localhost:5173/)**. Each time source file is saved, UI will automatically hot-reload so there is no need for `ALT+TAB` and `F5`. **For coding.** This will spin up a HTTP server on **[localhost:5173](http://localhost:5173/)**. Each time source file is saved, UI will automatically hot-reload so there is no need for `ALT+TAB` and `F5`.
@ -84,6 +106,7 @@ npm run dev
npm run build npm run build
``` ```
## 🤝 Credits ## 🤝 Credits
Of course, some third-party resources are used in this project. I kanged them for self-hosting, easier development and to avoid compatibility issues. Of course, some third-party resources are used in this project. I kanged them for self-hosting, easier development and to avoid compatibility issues.