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: More emojis 😃

Browse Source
This commit is contained in:
Daniel 2023-10-15 01:03:40 +02:00 committed by GitHub
parent f9a2d13f0a
commit 12c2e7a79c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -1,31 +1,28 @@
# honey
A sweet dashboard hosted on my homeserver with some self-hosted stuff...
A sweet dashboard I use on my homeserver with some self-hosted stuff...
<img src="screenshot.jpg" style="width: 720px">
## Installation
## 🚀 Installation
It's extremely easy. honey is built in mind of simplicity.
1. Please **go to [Releases](https://github.com/dani3l0/honey/releases) and download latest archive** with prebuilt assets (not the source code).
1. Download latest prebuilt archive from **[Releases](https://github.com/dani3l0/honey/releases)**.
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.
**Note:** honey is written in **pure** `HTML` `CSS` `JS` so dynamic backend or special webserver configuration is not required.
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.
### 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.
@ -42,9 +39,9 @@ The following keys are available under `ui` section. Some of them are listed in
| `animations` | Tells whether UI animations are enabled by default. | ✅ |
### Adding custom services
### 🔗 Adding custom services
`services` section is an array containing objects.
`services` section is an array containing objects. Object's structure looks like this:
| Key name | Description |
|--------------------|-------------------------------------------------------------------------------|
@ -55,28 +52,32 @@ The following keys are available under `ui` section. Some of them are listed in
## Development
## 🛠️ Development
honey is built on top of [Vite.js](https://vitejs.dev/). This tool allows for faster development and offers various code optimizations.
honey is built on top of [Vite.js](https://vitejs.dev/). This tool allows faster development and offers various optimizations.
Before proceeding, make sure you have all the requirements installed:
How to prepare a development environment:
```
# Download the source code
git clone https://github.com/dani3l0/honey && cd honey
# Install required modules
npm i
```
### Live server
### 🗼 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.
**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`.
```
npm run dev
```
### Build
### 🏗️ 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.
**Prepare project for production.** This command will link and optimize project assets to take less space and require less bandwith. Prebuilt assets will be stored in `dist` directory.
```
npm run build