Skip to content

Latest commit

 

History

History
109 lines (69 loc) · 3.91 KB

readme.md

File metadata and controls

109 lines (69 loc) · 3.91 KB
Raw

Contributors MIT License



Collection of curated apps for HyperOS the no bullshit home-server dashboard.
View apps · Request new app · Submit new app


This repository contains all official apps for hyperos.

  • Based on the hypr-repository template
  • Doesn't contain any core functionality for HyperOS, allowing users to build their own custom repository.

Contributing

Making new apps

Fork this repository, create a new app under the Apps directory.
Now, let's populate the folder with the files we need.

📂 yourapp
└ 📝 app.json

This file is your entry for describing the functionality of this app.

  • It works by extending the popular docker-compose format.
  • Auto-completion and intelisense is provided by a json schema, almost every field has a description on hover if you need it.
  • Every file path specified is relative to itself (ex: metadata/icons.png = Apps/<myappname>/icon.png)

Your App property describes how the app should behave on the front-end.

  • The directory property will be automatically filled for you when running the validation script or by husky when commiting.
  • The Icon property: click here To access our figma file with the icon template and many alredy-made icons.
    Like everything else on your app, the icon path is relative to app.json.

📂 yourapp
└ 📂 metadata
   └ 📝 app.md

This file is displayed on your app page under HyperOS web interface, it should contains a more detailed description about your app and what it does

HyperOS parses some extra tags to better fit the appStore:

  • <Gallery> </Gallery> The gallery tag accepts multiple images as content, drawing the horizontal image slide (usually shown as first element on appstore)
  • <Image appId="myapp" path="metadata/screenshot.jpg"/> Image requires the appId and image path as props, path is relative to app.json
Issues / Requesting new apps

Feel free to open issues requesting new apps, bare in mind the official repository has few rules that every app must fit:

  • Applications directly related to porn are not allowed.
  • Crypto mining related applications are not allowed, you might wanna look at Umbrel.

Pull requests

  • Icons must have same look-and-feel.
  • Non nullable environment variables must have a description.
  • Nullable environmet variables may have an empty string as value.
  • Unless required to function, apps should use the /hypros directory for volume bindings
  • Make sure your app has the needed metadata.

Your app is validated before you commit by Husky. Use the provided PR template whenever it's possible. You can manually validate your app to check if everything is going well by running npm run validate or yarn validate (remember to install dependencies first)