Skip to content

Latest commit

 

History

History
85 lines (69 loc) · 2.39 KB

README.md

File metadata and controls

85 lines (69 loc) · 2.39 KB
Raw

Solid App Store

An app store for Solid that displays developer tools and apps that exist in the Solid ecosystem

Setup and run HTTP server

Install dependencies:

$ npm install

Run development server:

$ npm run watch

Run production sever:

$ npm start

How to add app to store

An app has to either offer a Client ID document or have a schema.org description.

Solid-OIDC Client ID Document

You find information on Solid-OIDC Client ID documents here. The Client ID has to be serialized as application/ld+json. An example looks like this:

{
  "@context": ["https://www.w3.org/ns/solid/oidc-context.jsonld"],

  "client_name": "Solid Application Name",
  "client_uri": "https://app.example/",
  "logo_uri" : "https://app.example/logo.png",
  "http://schema.org/description": "description",
  "http://schema.org/category" : [
    {
      "@id": "https://data.knows.idlab.ugent.be/person/office/application-categories#reference"
    }
  ]
}

Categories are required to have an id from https://data.knows.idlab.ugent.be/person/office/application-categories. Logo, description, and categories are optional. You find a corresponding SHACL file here.

Schema.org description

You can describe an app via schema.org. An example looks like this:

{
  "@context": {
    "@vocab": "http://schena.org/",
    "logo": {"@type": "@id"},
    "codeRepository": {"@type": "@id"},
    "category": {"@type": "@id"},
    "hasGit": {"@reverse": "targetProduct"}
  },
  "@id":"http://app.example",
  "@type": "SoftwareApplication",
  "name": "Solid Application Name",
  "description": "description",
  "logo": "https://app.example/logo.png",
  "category": ["https://data.knows.idlab.ugent.be/person/office/application-categories#reference"],
  "hasGit": {
    "@id": "http://app.example/repo",
    "codeRepository": "https://github.com/example/code"
  }
}

Categories are required to have an id from https://data.knows.idlab.ugent.be/person/office/application-categories. Logo, description, and categories are optional. You find a corresponding SHACL file here.

License

This code is copyrighted by Ghent University – imec and released under the MIT license.