Wiki source code of Creating a community app
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | == Community apps in collabs == | ||
| 2 | |||
| 3 | Community apps are services developed by the EBRAINS community of users, and that can be added to the navigation of any collab. For this, the app needs to be registered in a space called the "Community 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 for an EBRAINS user to creating a community app is to **get the service developer accreditation**. Contributors can register and manage apps within the Community Apps Catalogue. | ||
| 9 | |||
| 10 | Users can request service developer accreditation by performing both of the following 2 steps: | ||
| 11 | |||
| 12 | 1. opening an EBRAINS support ticket at [[https:~~/~~/ebrains.eu/support>>https://ebrains.eu/support]] with a short motivation for the request, and | ||
| 13 | 1. navigating the the 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]] and clicking the big green "request to join" button. | ||
| 14 | |||
| 15 | The support team will apply the permissions to your user. | ||
| 16 | |||
| 17 | {{info}} | ||
| 18 | HBP accredited members will automatically be approved. Other EBRAINS users will be required to sign an an agreement in order to obtain service developer accreditation. | ||
| 19 | {{/info}} | ||
| 20 | |||
| 21 | |||
| 22 | == Making your app available to users == | ||
| 23 | |||
| 24 | 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/]]. | ||
| 25 | |||
| 26 | If the users of your app 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 authenticating EBRAINS users and creating an OIDC client. | ||
| 27 | |||
| 28 | |||
| 29 | === Register your app in the Community Apps Catalogue === | ||
| 30 | |||
| 31 | The Apps Catalogue is available at: [[https:~~/~~/wiki.ebrains.eu/bin/view/Apps/>>https://wiki.ebrains.eu/bin/view/Apps/]] | ||
| 32 | |||
| 33 | |||
| 34 | 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. | ||
| 35 | |||
| 36 | (% style="text-align:center" %) | ||
| 37 | [[image:create-app.png||height="518" width="1250"]] | ||
| 38 | |||
| 39 | Then create a new space in the Apps Catalogue for your app using the "Community Apps" type. | ||
| 40 | |||
| 41 | (% style="text-align:center" %) | ||
| 42 | [[image:create-app-2.png||height="982" width="1250"]] | ||
| 43 | |||
| 44 | Fill the form in the following step with the following information: | ||
| 45 | |||
| 46 | * **main URL**: the URL of the homepage of your app. This is where the users will be directed when they open your app in a collab. | ||
| 47 | * **settings URL**: the URL of your app's settings management page, if there is one. | ||
| 48 | * **description**: a description of what your app does. This helps users choose the apps they install. | ||
| 49 | * **under development?**: if checked, your app will not be available to other users. | ||
| 50 | * **category**: a category to help structure the list of apps. | ||
| 51 | * **maintainers**: a list of users who maintain the app. The users need to have logged in the wiki at least once to appear on the list. Maintainers are granted the right to modify the app's registration. | ||
| 52 | * **documentation URL**: if your app has online user documentation, a link will be provided to users when they use your app. | ||
| 53 | * **repository**: a URL to a public repository so users can access the source code of your app. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | |||
| 57 | ==== Add a logo (optional) ==== | ||
| 58 | |||
| 59 | 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. | ||
| 60 | |||
| 61 | === Add an app to your collab === | ||
| 62 | |||
| 63 | 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. | ||
| 64 | |||
| 65 | (% style="text-align:center" %) | ||
| 66 | [[image:add.png||height="617" width="1250"]] | ||
| 67 | |||
| 68 | Then click the Create button and the app will have been added in the collab's navigation menu. | ||
| 69 | |||
| 70 |