An open API service indexing awesome lists of open source software.

https://github.com/os-js/osjs-example-provider

OS.js Example Service Provider
https://github.com/os-js/osjs-example-provider

osjs osjs-provider

Last synced: 11 months ago
JSON representation

OS.js Example Service Provider

Awesome Lists containing this project

README

          


OS.js Logo

[OS.js](https://www.os-js.org/) is an [open-source](https://raw.githubusercontent.com/os-js/OS.js/master/LICENSE) web desktop platform with a window manager, application APIs, GUI toolkit, filesystem abstractions and much more.

[![Support](https://img.shields.io/badge/patreon-support-orange.svg)](https://www.patreon.com/user?u=2978551&ty=h&u=2978551)
[![Support](https://img.shields.io/badge/opencollective-donate-red.svg)](https://opencollective.com/osjs)
[![Donate](https://img.shields.io/badge/liberapay-donate-yellowgreen.svg)](https://liberapay.com/os-js/)
[![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://paypal.me/andersevenrud)
[![Community](https://img.shields.io/badge/join-community-green.svg)](https://community.os-js.org/)

# OS.js Example Service Provider

This is the Example Service Provdider for OS.js

## Installation

```
npm install @osjs/example-provider
```

## Usage

In you startup procedure, simply import and register:

> Note: This example is written using ESM. Node does not support this out of the box, so assume this is a client scipt.

```
import {ExampleServiceProvider} from '@osjs/example-provider'; // You want your package name here

// ...

osjs.register(ExampleServiceProvider)

// ...

```

Then you can use `core.make('example/instance')` or `core.make('example/singleton')` (as provided by this example).

## Contribution

* **Sponsor on [Github](https://github.com/sponsors/andersevenrud)**
* **Become a [Patreon](https://www.patreon.com/user?u=2978551&ty=h&u=2978551)**
* **Support on [Open Collective](https://opencollective.com/osjs)**
* [Contribution Guide](https://github.com/os-js/OS.js/blob/master/CONTRIBUTING.md)

## Documentation

See the [Official Manuals](https://manual.os-js.org/) for articles, tutorials and guides.

## Links

* [Official Chat](https://gitter.im/os-js/OS.js)
* [Community Forums and Announcements](https://community.os-js.org/)
* [Homepage](https://os-js.org/)
* [Twitter](https://twitter.com/osjsorg) ([author](https://twitter.com/andersevenrud))
* [Google+](https://plus.google.com/b/113399210633478618934/113399210633478618934)
* [Facebook](https://www.facebook.com/os.js.org)
* [Docker Hub](https://hub.docker.com/u/osjs/)