aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md20
-rw-r--r--CODE_OF_CONDUCT.md84
-rw-r--r--CONTRIBUTING.md47
-rw-r--r--README.md16
4 files changed, 162 insertions, 5 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..e0bcfe2
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,20 @@
1## Description
2
3Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4
5Fixes # (issue)
6
7## Type of change
8
9Please delete options that are not relevant.
10
11- [ ] Bug fix (non-breaking change which fixes an issue)
12- [ ] New feature (non-breaking change which adds functionality)
13- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14
15## Checklist:
16
17- [ ] I read & comply with the [contributing guidelines](https://github.com/bastienwirtz/homer/blob/master/.github/CONTRIBUTING.md)
18- [ ] I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.
19- [ ] I have made corresponding changes the documentation (README.md).
20- [ ] I've check my modifications for any breaking change, especially in the `config.yml` file
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..6a89cb4
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,84 @@
1
2# Contributor Covenant Code of Conduct
3
4## Our Pledge
5
6We as members, contributors, and leaders pledge to make participation in our
7community a harassment-free experience for everyone, regardless of age, body
8size, visible or invisible disability, ethnicity, sex characteristics, gender
9identity and expression, level of experience, education, socio-economic status,
10nationality, personal appearance, race, religion, or sexual identity
11and orientation.
12
13We pledge to act and interact in ways that contribute to an open, welcoming,
14diverse, inclusive, and healthy community.
15
16## Our Standards
17
18Examples of behavior that contributes to a positive environment for our
19community include:
20
21* Demonstrating empathy and kindness toward other people
22* Being respectful of differing opinions, viewpoints, and experiences
23* Giving and gracefully accepting constructive feedback
24* Accepting responsibility and apologizing to those affected by our mistakes,
25 and learning from the experience
26* Focusing on what is best not just for us as individuals, but for the
27 overall community
28
29Examples of unacceptable behavior include:
30
31* The use of sexualized language or imagery, and sexual attention or
32 advances of any kind
33* Trolling, insulting or derogatory comments, and personal or political attacks
34* Public or private harassment
35* Publishing others' private information, such as a physical or email
36 address, without their explicit permission
37* Other conduct which could reasonably be considered inappropriate in a
38 professional setting
39
40## Enforcement Responsibilities
41
42Community leaders are responsible for clarifying and enforcing our standards of
43acceptable behavior and will take appropriate and fair corrective action in
44response to any behavior that they deem inappropriate, threatening, offensive,
45or harmful.
46
47Community leaders have the right and responsibility to remove, edit, or reject
48comments, commits, code, wiki edits, issues, and other contributions that are
49not aligned to this Code of Conduct, and will communicate reasons for moderation
50decisions when appropriate.
51
52## Scope
53
54This Code of Conduct applies within all community spaces, and also applies when
55an individual is officially representing the community in public spaces.
56Examples of representing our community include using an official e-mail address,
57posting via an official social media account, or acting as an appointed
58representative at an online or offline event.
59
60## Enforcement
61
62Instances of abusive, harassing, or otherwise unacceptable behavior may be
63reported to the community leaders responsible for enforcement at
64bastien.wirtz@gmail.com.
65All complaints will be reviewed and investigated promptly and fairly.
66
67All community leaders are obligated to respect the privacy and security of the
68reporter of any incident.
69
70## Attribution
71
72This Code of Conduct is adapted from the [Contributor Covenant][homepage],
73version 2.0, available at
74https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
75
76Community Impact Guidelines were inspired by [Mozilla's code of conduct
77enforcement ladder](https://github.com/mozilla/diversity).
78
79[homepage]: https://www.contributor-covenant.org
80
81For answers to common questions about this code of conduct, see the FAQ at
82https://www.contributor-covenant.org/faq. Translations are available at
83https://www.contributor-covenant.org/translations.
84
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..438c6e7
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,47 @@
1# Introduction
2
3### Welcome!
4
5First off, thank you for considering contributing to Homer!
6
7### Project philosophy
8
9Homer is meant to be a light and very simple dashboard that keeps all your usefull utilities at hands. The few features implemented in Homer focus on
10UX and usability. If you are looking for a full featured dashboard, there is tons of great stuff out there like https://heimdall.site/, https://github.com/rmountjoy92/DashMachine or https://organizr.app/.
11
12- Configuration is stored in a simple config file, avoiding the need for a backend/database while making possible to use versionning or [config template](https://docs.ansible.com/ansible/latest/user_guide/playbooks_templating.html).
13- Only modern browsers are supported, feel free to use any JS features without any polyfill as soon as the latest version of the major browsers supports them.
14
15### Roadmap
16
17If you want to know more about the project direction or looking for something to work on, checkout the [roadmap](https://github.com/bastienwirtz/homer#Roadmap)!
18Feel free to open an issue if you have any question.
19
20# Ground Rules
21
22### Code of conduct and guidelines
23
24First of all, we expect everyone (contributors and maintainers alike) to respect the [Code of conduct](https://github.com/bastienwirtz/homer/blob/master/CODE_OF_CONDUCT.md). It is not a recomandation, it is mandatory.
25
26For all contributions, please respect the following guidelines:
27
28* Each pull request should implement ONE feature or bugfix. If you want to add or fix more than one thing, submit more than one pull request.
29* Do not commit changes to files that are irrelevant to your feature or bugfix (eg: `.gitignore`).
30* Do not add unnecessary dependencies.
31* Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request.
32
33# Getting started
34
35### Discuss about ideas
36
37If you want to add a feature, it's often best to talk about it before starting working on it and submitting a pull request. It's not mandatory at all, but
38feel free to open an issue to present your idea.
39
40### How to submit a contribution
41
42The general process to submit a contribution is as follow:
431. Create your own fork of the code
442. Do the changes in your fork
453. Make sure to fill the [pull request description](https://github.com/bastienwirtz/homer/blob/master/.github/PULL_REQUEST_TEMPLATE.md) properly.
46
47### Happy coding :metal:
diff --git a/README.md b/README.md
index 11d4714..5ab7c26 100644
--- a/README.md
+++ b/README.md
@@ -5,9 +5,15 @@ A dead simple static **HOM**epage for your serv**ER** to keep your services on h
5 5
6If 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, ...) 6If 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, ...)
7 7
8![screenshot](https://github.com/bastienwirtz/homer/blob/master/screenshot.png) 8![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png)
9 9
10## installation 10## Roadmap
11
12- [ ] Colors / theme customization
13- [ ] Enable PWA support (making possible to "install" - add to homescreen - it)
14- [ ] Improve maintenability (external library import & service workers cached file list.)
15
16## Installation
11 17
12### Using docker 18### Using docker
13 19
@@ -17,10 +23,10 @@ sudo docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/
17 23
18### Manually 24### Manually
19 25
20**How to build / install it?** There is no build system (😱), use it like that! It'meant to be stupid simple & zero maintenance required. just copy the static files somewhere, and visit the `index.html`. 26**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`.
21 27
22 28
23## configuration 29## Configuration
24 30
25Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format. 31Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format.
26 32
@@ -113,4 +119,4 @@ If you choose to fetch message information from an endpoint, the output format s
113``` 119```
114 120
115`null` value or missing keys will be ignored and value from the `config.yml` will be used if available. 121`null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
116Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar) 122Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).