Creating a community app

== Community apps in collabs ==

Community apps are services developed by the EBRAINS community of users, yes, and that can be added to the navigation of any collab (by a collab's editors). For this, the app needs to be registered in a space called the "Apps Catalogue". Once the app is registered, adding such an app to a collab is as simple as creating a new Wiki page in the collab.

4

5

6

== Becoming a contributor ==

7

8

The first step to creating community apps is for you to **get the developer accreditation**. Contributors can register and manage apps within the Community Apps Catalogue.

9

10

Send an email to [[support@ebrains.eu>>path:mailto:support@ebrains.eu]] with a short motivation for your request.

11

12

The support team will apply the permissions to your user. Your account will be [[upgraded with developer privileges>>url:https://wiki.ebrains.eu/bin/view/Collabs/collab-devs/collaboratory-v2/keycloak/user%20administration/]] the next time you login.

13

14

15

Only SGA3 accredited users will be automatically granted the developer accreditation.

16

17

18

== Making your app available to users ==

19

20

In order for users to install your app, it needs to be registered in the [[Community Apps Catalogue>>url:https://wiki.ebrains.eu/bin/view/Apps/]].

21

22

If you are dealing with private data, or your users need to be authenticated, see [[managing authorisation in the Collaboratory>>doc:Collabs.the-collaboratory.Documentation IAM.FAQ.Managing Authorizations.WebHome]] or[[ OIDC clients explained>>doc:Collabs.the-collaboratory.Documentation IAM.FAQ.OIDC Clients explained.WebHome]] and its sub-pages for a more detailed overview of OIDC clients.

23

24

=== Register your app in the Apps Catalogue ===

25

26

The Apps Catalogue is available at: [[https:~~/~~/wiki.ebrains.eu/bin/view/Apps/>>https://wiki.ebrains.eu/bin/view/Apps/]]

27

28

App registration is only available to members of this group: [[https:~~/~~/wiki.ebrains.eu/bin/view/Identity/#/groups/app-collaboratory-iam~~-~~-service-providers>>https://wiki.ebrains.eu/bin/view/Identity/#/groups/app-collaboratory-iam--service-providers]]

29

30

To register an app, click on "Create App", if the button does not appear, you are probably not a member of the [[group>>https://wiki.ebrains.eu/bin/view/Identity/#/groups/app-collaboratory-iam--service-providers]] previously mentioned. From that Group page, you can request to become a member which will in turn grant you permission to register apps.

31

32

(% style="text-align:center" %)

33

[[image:create-app.png||height="518" width="1250"]]

34

35

Then create a new space in the Apps Catalogue for your app using the "Community Apps" type.

36

37

(% style="text-align:center" %)

38

[[image:create-app-2.png||height="982" width="1250"]]

39

40

On the next step, fill the form to register your app. Note that only **users registered in the "maintainers" field will be able to edit this form**. Don't forget to add yourself. When done, click on the "Save & View" button; it displays a summary of information you have just filled. Your app is now available to be used in the Wiki.

41

42

==== Add a logo (optional) ====

43

44

Some of users like to add a logo to their app. The logo is only visible when browsing the catalogue. To do so, the user has to add a PNG file attachment with the filename "logo.png" in the attachment tab at the bottom of the summary page displayed after the "Save & View" action above.

45

46

=== Add an app to your collab ===

47

48

Adding an app to a collab is a simple as creating a new wiki page. As an admin or editor of a collab, a user can add a community app by clicking the "+ Create" button at the top of any wiki page, and selecting the "Community App" type.

49

50

(% style="text-align:center" %)

51

[[image:add.png||height="617" width="1250"]]

52

53

Then click the Create button and the app will have been added in the collab's navigation menu.

54

55