-
-
Notifications
You must be signed in to change notification settings - Fork 771
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Build system integration using vue-cli. #62
Merged
Merged
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
b9c5fcf
Build system integration using vue-cli.
bastienwirtz e114275
Remove config.yml from versionning.
bastienwirtz 9814a03
Pure CSS font awesome icon
bastienwirtz 3bf0edc
Adding missing rel attribute on links.
bastienwirtz 1875c17
Full offline support (local fonts)
bastienwirtz 2301d89
Adding PWA icons for proper pwa support
bastienwirtz 9052ec5
Fix logo always shown issue.
bastienwirtz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
> 1% | ||
last 2 versions | ||
not dead |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
module.exports = { | ||
root: true, | ||
env: { | ||
node: true, | ||
}, | ||
extends: ["plugin:vue/essential", "eslint:recommended", "@vue/prettier"], | ||
parserOptions: { | ||
parser: "babel-eslint", | ||
}, | ||
rules: { | ||
"no-console": "off", | ||
"no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off", | ||
"vue/require-v-for-key": "off", | ||
}, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
.DS_Store | ||
node_modules | ||
/dist | ||
|
||
# local env files | ||
.env.local | ||
.env.*.local | ||
|
||
# Log files | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
# Editor directories and files | ||
.idea | ||
.vscode | ||
*.suo | ||
*.ntvs* | ||
*.njsproj | ||
*.sln | ||
*.sw? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,22 +6,24 @@ A dead simple static **HOM**epage for your serv**ER** to keep your services on h | |
|
||
It supports keyboard shortcuts: | ||
|
||
* `/` Start searching. | ||
* `Escape` Stop searching. | ||
* `Enter` Open the first matching result (respects the bookmark's `_target` property). | ||
* `Alt`/`Option` + `Enter` Open the first matching result in a new tab. | ||
- `/` Start searching. | ||
- `Escape` Stop searching. | ||
- `Enter` Open the first matching result (respects the bookmark's `_target` property). | ||
- `Alt`/`Option` + `Enter` Open the first matching result in a new tab. | ||
|
||
If you need authentication support, you're on your own (it can be secured using a web server auth module or exposing it only through a VPN network / SSH tunnel, ...) | ||
|
||
![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png) | ||
|
||
## Roadmap | ||
|
||
* [ ] Colors / theme customization | ||
* [ ] Enable PWA support (making possible to "install" - add to homescreen - it) | ||
* [ ] Improve maintainability (external library import & service workers cached file list.) | ||
- [ ] Add more themes. | ||
- [ ] Add support for custom service card (add custom feature to some service / app link) | ||
- [x] Colors / theme customization | ||
- [x] Enable PWA support (making possible to "install" - add to homescreen - it) | ||
- [x] Improve maintainability (external library import & service workers cached file list.) | ||
|
||
## Installation | ||
## Usage | ||
|
||
### Using docker | ||
|
||
|
@@ -31,7 +33,51 @@ sudo docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/ | |
|
||
### Manually | ||
|
||
**How to build / install it?** There is no build system (😱), use it like that! It's meant to be stupid simple & zero maintenance required. Just copy the static files somewhere, and visit the `index.html`. | ||
Homer is a static page that need to be generated from the source in this repository. | ||
Use the folowing command to build the project: | ||
|
||
```sh | ||
# Using yarn (recommended) | ||
yarn install | ||
yarn build | ||
|
||
# **OR** Using npm | ||
npm install | ||
npm run build | ||
``` | ||
|
||
Then your dashboard is ready to use in the `/dist` directory. | ||
Use it like any static HTML content (use a webserver or open the html index directly). | ||
|
||
## Developement | ||
|
||
```sh | ||
# Using yarn (recommended) | ||
yarn install | ||
yarn serve | ||
|
||
# **OR** Using npm | ||
npm install | ||
npm run serve | ||
``` | ||
|
||
### themes | ||
|
||
Theme are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Themes are meant.. |
||
To addd a new theme, just add a file in the theme directory, and put all style in the `body #app.theme-<name>` scope. Then import it in the main style file. | ||
|
||
```scss | ||
// `src/assets/themes/my-awesome-theme.scss` | ||
body #app.theme-my-awesome-theme. { ... } | ||
``` | ||
|
||
```scss | ||
// `src/assets/app.scss` | ||
// Themes import | ||
@import "./themes/sui.scss"; | ||
... | ||
@import "./themes/my-awesome-theme.scss"; | ||
``` | ||
|
||
## Configuration | ||
|
||
|
@@ -42,12 +88,46 @@ Title, icons, links, colors, and services can be configured in the `config.yml` | |
# Homepage configuration | ||
# See https://fontawesome.com/icons for icons options | ||
|
||
title: "Simple homepage" | ||
title: "App dashboard" | ||
subtitle: "Homer" | ||
logo: "assets/homer.png" | ||
# Alternatively a fa icon can be provided: | ||
# icon: "fas fa-skull-crossbones" | ||
footer: '<p>Created with <span class="has-text-danger">❤️</span> with <a href="https://bulma.io/">bulma</a>, <a href="https://vuejs.org/">vuejs</a> & <a href="https://fontawesome.com/">font awesome</a> // Fork me on <a href="https://github.com/bastienwirtz/homer"><i class="fab fa-github-alt"></i></a></p>' # set false if you want to hide it.header: | ||
# icon: "fas fa-skull-crossbones" | ||
|
||
header: true # Set to false to hide the header | ||
footer: '<p>Created with <span class="has-text-danger">❤️</span> with <a href="https://bulma.io/">bulma</a>, <a href="https://vuejs.org/">vuejs</a> & <a href="https://fontawesome.com/">font awesome</a> // Fork me on <a href="https://github.com/bastienwirtz/homer"><i class="fab fa-github-alt"></i></a></p>' # set false if you want to hide it.header: | ||
|
||
# Optional theming | ||
theme: default # 'default' or one of the theme available in 'src/assets/themes'. | ||
|
||
# Here is the exaustive list of customization parameters | ||
# However all value are optional and will fallback to default if not set. | ||
# if you want to change only some of the colors, feel free to remove all unused key. | ||
colors: | ||
light: | ||
highlight-primary: "#3367d6" | ||
highlight-secondary: "#4285f4" | ||
highlight-hover: "#5a95f5" | ||
background: "#f5f5f5" | ||
card-background: "#ffffff" | ||
text: "#363636" | ||
text-header: "#424242" | ||
text-title: "#303030" | ||
text-subtitle: "#424242" | ||
card-shadow: rgba(0, 0, 0, 0.1) | ||
link-hover: "#363636" | ||
dark: | ||
highlight-primary: "#3367d6" | ||
highlight-secondary: "#4285f4" | ||
highlight-hover: "#5a95f5" | ||
background: "#131313" | ||
card-background: "#2b2b2b" | ||
text: "#eaeaea" | ||
text-header: "#ffffff" | ||
text-title: "#fafafa" | ||
text-subtitle: "#f5f5f5" | ||
card-shadow: rgba(0, 0, 0, 0.4) | ||
link-hover: "#ffdd57" | ||
|
||
# Optional message | ||
message: | ||
|
@@ -62,7 +142,7 @@ links: | |
- name: "ansible" | ||
icon: "fab fa-github" | ||
url: "https://github.com/xxxxx/ansible/" | ||
target: '_blank' # optional html a tag target attribute | ||
target: "_blank" # optional html a tag target attribute | ||
- name: "Wiki" | ||
icon: "fas fa-book" | ||
url: "https://wiki.xxxxxx.com/" | ||
|
@@ -81,7 +161,7 @@ services: | |
subtitle: "Continuous integration server" | ||
tag: "CI" | ||
url: "#" | ||
target: '_blank' # optional html a tag target attribute | ||
target: "_blank" # optional html a tag target attribute | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. drop the "a" |
||
- name: "RabbitMQ Management" | ||
logo: "/assets/tools/rabbitmq.png" | ||
subtitle: "Manage & monitor RabbitMQ server" | ||
|
@@ -111,7 +191,6 @@ services: | |
subtitle: "Pingdom public reports overview" | ||
tag: "CI" | ||
url: "#" | ||
|
||
``` | ||
|
||
If you choose to fetch message information from an endpoint, the output format should be: | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Themes (capital t)