bastienwirtz / homer

A very simple static homepage for your server.

self-hosted homepage hacktoberfest vuejs dashboard toolbox

Homer

Homer is a very simple, static homepage for your server.

It features:

• A dashboard to display system information
• A list of your repositories on GitHub
• A list of your open pull requests
• A list of your recent commits
• A list of your starred repositories
• A list of your followers
• A list of your following
• A list of your recent activity
• A list of your recent notifications

Homer is built with Vue.js and is fully self-hosted. It is also open source and free to use.

Installation

To install Homer, simply run the following command:

npm install -g homer

Once Homer is installed, you can run it by running the following command:

homer

Homer will then be available at http://localhost:3000.

Configuration

You can configure Homer by creating a .homer.config.js file in your home directory. The following options are available:

• port: The port that Homer will listen on. Defaults to 3000.
• username: Your GitHub username. Defaults to the username you used to log in to GitHub.
• token: Your GitHub token. You can generate a token at https://github.com/settings/tokens.
• repo: The GitHub repository that you want to display on the dashboard. Defaults to your primary repository.
• theme: The theme that you want to use. Defaults to light.

Contributing

Homer is open source and free to use. Contributions are welcome!

To contribute, simply fork the Homer repository on GitHub and create a pull request.

License

Homer is licensed under the MIT License.