Initial commit

.gitignore

@@ -0,0 +1 @@
+.DS_Store

README.md

@@ -0,0 +1,39 @@
+## Umbrel Community App Store Template
+
+This repository is a template to create an Umbrel Community App Store. These additional app stores allow developers to distribute applications without submitting to the [Official Umbrel App Store](https://github.com/getumbrel/umbrel-apps).
+
+Just click the "Use this template" button above and start adding your own apps!
+
+### Technical Details
+
+The `umbrel-app-store.yml` file defines two important properties:
+- `id` - This is used as a prefix for all apps within the community app store. You **MUST** prefix your application id with your app store ID. For example, this template defines `sparkles` as a community app store ID and we have a `hello world` app. The app ID therefore should be: `sparkles-hello-world`
+- `name` - This name appears within the Umbrel user interface when users explore apps within these community app stores.
+
+
+### Testing
+
+To test your community app store, you can add this repository through the Umbrel user interface as shown in the following demo:
+
+
+https://user-images.githubusercontent.com/10330103/197889452-e5cd7e96-3233-4a09-b475-94b754adc7a3.mp4
+
+
+Alternatively, you can use the Umbrel CLI as described below.
+
+To add an app store:
+```
+sudo ~/umbrel/scripts/repo add https://github.com/getumbrel/umbrel-community-app-store.git
+
+sudo ~/umbrel/scripts/repo update
+```
+
+To install an app from the app store
+```
+sudo ~/umbrel/scripts/app install sparkles-hello-world
+```
+
+To remove an app store:
+```
+sudo ~/umbrel/scripts/repo remove https://github.com/getumbrel/umbrel-community-app-store.git
+```

sparkles-hello-world/docker-compose.yml

@@ -0,0 +1,14 @@
+version: "3.7"
+
+services:
+
+  app_proxy:
+    environment:
+      # The format here is: <app-id>_<docker-service-name>_1
+      APP_HOST: sparkles-hello-world_server_1
+      APP_PORT: 3000
+    
+  server:
+    image: getumbrel/community-app-store-hello-world:latest
+    user: "1000:1000"
+    init: true

sparkles-hello-world/umbrel-app.yml

@@ -0,0 +1,30 @@
+manifestVersion: 1
+id: sparkles-hello-world
+name: Hello World
+tagline: Replace this tagline with your app's tagline
+icon: https://svgur.com/i/mvA.svg
+category: Development
+version: "1.0.0"
+port: 4000
+description: >-
+  Add your app's description here.
+
+
+  You can also add newlines!
+
+developer: Umbrel
+website: https://umbrel.com
+submitter: Umbrel
+submission: https://github.com/getumbrel/umbrel-hello-world-app
+repo: https://github.com/getumbrel/umbrel-hello-world-app
+support: https://github.com/getumbrel/umbrel-hello-world-app/issues
+gallery:
+  - https://i.imgur.com/yyVG0Jb.jpeg
+  - https://i.imgur.com/yyVG0Jb.jpeg
+  - https://i.imgur.com/yyVG0Jb.jpeg
+releaseNotes: >-
+  Add what's new in the latest version of your app here.
+dependencies: []
+path: ""
+defaultUsername: ""
+defaultPassword: ""

umbrel-app-store.yml

@@ -0,0 +1,2 @@
+id: "sparkles" # Choose the ID for your app store. This should contain only alphabets ("a to z") and dashes ("-").
+name: "Sparkles" # Choose the name of your app store. It will show up in the UI as "<name> App Store".