Skip to content

Apps is the application dashboard for apps.while-true-do.io.

License

Notifications You must be signed in to change notification settings

whiletruedoio/apps

Cirrus CI - Base Branch Build Status CodeFactor GitHub Tag (latest SemVer) Docker Image Version GitHub issues GitHub pull requests GitHub license

Apps

Apps is the application dashboard for <apps.while-true-do.io>.

Motivation

Discovering exting services, applications, documentation and other important links should be easy and convenient. This makes it easier for new members to find these services and avoids maintaining bookmarks.

Development Situation

The intention of "Apps" is to provide an easy to use dashboard. It should also provide some quality-of-life helpers, like a web search and basic availability checking and version display.

As long as the real application is in development, we have agreed to use a very easy to use software, named Homer. It provides ~70% of our desired features and behavior and we are really grateful for this awesome piece of software.

Therefore, this repository only contains a re-build of the container image for our use.

Description

Apps is an application to provide a landing page/app overview of existing services, applications, links and documentation.

Usage

We are really happy, that you consider using our software. In case you want to install and run the code on your machine, please check out this section.

Requirements

To run the application, you need to have a container engine (like docker or podman) installed.

Installation

Currently, a deployment as container is supported. Our resulting build can be found on Docker Hub. Installing and starting the application is as easy as:

# Pull image
$ podman pull docker.io/whiletruedoio/apps

# Start container
$ podman run -dt -p 8080:8080 docker.io/whiletruedoio/apps

Documentation

Afterwards, you can point your browser to the desired IP address (for example http://localhost:8080) and will be presented with the dashboard. Clicking the links should open a new tab with the service.

Contribute

Thank you so much for considering to contribute! We are happy, when someone is joining the hard work.

Issues

Issues and Pull Requests are handled on a regular basis. Please be aware, that we may reach out to you, ask you to provide additional resources or want to discuss the issue a little, before planning it.

Develop

Providing code to this repository is pretty straight forward. Open an issue, so we can discuss the bug/feature and start working on it afterwards. You just need to open the pull request afterwards and that's it.

It is also strongly recommended to read the Contribution Guideline beforehand.

Changelog

We are maintaining a changelog for repositories. Normally, the developers will update the changelog, according to keepachangelog.com.

Test

To ensure a high quality and functionality, we want to carefully test our software. The provided code is automatically tested as described in the .cirrus.yml.

License

Except otherwise noted, all work is licensed under a BSD-3-Clause License.

Contact

Please feel free to reach out to us and the community. We also recommend to read and understand the Code of Conduct beforehand.

About

Apps is the application dashboard for apps.while-true-do.io.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published