open-index/open-npm huggingface dataset:
npm package: @open-rpc/docs-react
Description: OpenRPC documentation as a react component
Latest version: 2.1.1

# docs-react
OpenRPC documentation as a react component

#### What is this?
This is a react component that will render documentation for a given OpenRPC document.

**Screenshot**:

![image](https://user-images.githubusercontent.com/364566/54795109-1b1f5b80-4c08-11e9-9ba9-cc2f2d96c692.png)


#### How do I use this?

##### Installation:
```
npm install --save @open-rpc/docs-react
```
##### Usage:
```
import Documentation from "@open-rpc/docs-react";
```
and then use it somewhere:

```
<Documentation schema={schema} />
```

##### Example in a new project:

###### create a new typescript project with `create-react-app`

```
npx create-react-app <appname> --typescript
```

```
cd <appname>
npm install .
npm install @open-rpc/docs-react @open-rpc/meta-schema --save
```

###### index.ts
```
import React from 'react';
import ReactDOM from 'react-dom';
import Documentation from "@open-rpc/docs-react";
import { OpenrpcDocument } from '@open-rpc/meta-schema';

const schema: OpenrpcDocument = {
  openrpc: "1.2.4",
  info: {
    "version": "0.0.0-development",
    "title": "My New API"
  },
  methods: []
};

ReactDOM.render(<Documentation schema={schema} />, document.getElementById("root"));

```

###### screenshot
![image](https://user-images.githubusercontent.com/364566/54797953-920e2180-4c13-11e9-9ff8-723a836d0e2c.png)
npm package: @open-rpc/examples
Description: Collection of example OpenRPC service definition files
Latest version: 1.7.2

# examples

<center>
  <span>
    <img alt="CircleCI branch" src="https://img.shields.io/circleci/project/github/open-rpc/examples/master.svg">
    <img alt="npm" src="https://img.shields.io/npm/dt/@open-rpc/examples.svg" />
    <img alt="GitHub release" src="https://img.shields.io/github/release/open-rpc/examples.svg" />
    <img alt="GitHub commits since latest release" src="https://img.shields.io/github/commits-since/open-rpc/examples/latest.svg" />
  </span>
</center>

Collection of example OpenRPC Documents

Need help or have a question? Join us on [Discord](https://discord.gg/gREUKuF)!

### Contributing

How to contribute, build and release are outlined in [CONTRIBUTING.md](CONTRIBUTING.md), [BUILDING.md](BUILDING.md) and [RELEASING.md](RELEASING.md) respectively. Commits in this repository follow the [CONVENTIONAL_COMMITS.md](CONVENTIONAL_COMMITS.md) specification.
npm package: @open-rpc/generator
Description: <center>   <span>     <img alt="CircleCI branch" src="https://img.shields.io/circleci/project/github/open-rpc/generator/master.svg">     <img src="https://codecov.io/gh/open-rpc/generator/branch/master/graph/badge.svg" />     <img alt="npm" src="https://i
Latest version: 2.1.1

# OpenRPC Generator

<center>
  <span>
    <img alt="CircleCI branch" src="https://img.shields.io/circleci/project/github/open-rpc/generator/master.svg">
    <img src="https://codecov.io/gh/open-rpc/generator/branch/master/graph/badge.svg" />
    <img alt="npm" src="https://img.shields.io/npm/dt/@open-rpc/generator.svg" />
    <img alt="GitHub release" src="https://img.shields.io/github/release/open-rpc/generator.svg" />
    <img alt="GitHub commits since latest release" src="https://img.shields.io/github/commits-since/open-rpc/generator/latest.svg" />
  </span>
</center>

A Generator tool for [open-rpc](https://github.com/open-rpc/spec) APIs.

Need help or have a question? Join us on [Discord](https://discord.gg/gREUKuF)!

## Features:

- Built in components for:
  - Clients
  - Server
  - Documentation
- Easy to create new components


## Usage

The generator CLI has a generate command which takes a config to run. The config specifies what components you want to make, as well as the configuration for each component.

Using the CLI's `init` command, you can walk though an interactive config builder.

### Quick start

```sh
npm install -g @open-rpc/generator

open-rpc-generator init
open-rpc-generator generate -c open-rpc-generator-config.json
```

### Generating an individual component

```shell
open-rpc-generator generate \
  -t client \
  -l typescript \
  -n petstoreClientTs \
  -d https://raw.githubusercontent.com/open-rpc/examples/master/service-descriptions/petstore-openrpc.json \
  -o ./generated
```
### Custom Component Generation Configuration
Here for customComponent we specify the module that exports as
default the type IComponentModule see custom-test-component.js as an example. It is easy to also refer to an npm package as well as a plain js file. customType is can be anything , it is not restricted to client | server | doc naming.
```
{
  "openrpcDocument": "./src/awesome-custom-client_openrpc.json",
  "outDir": "generated-client",
  "components": [
      {
          "type": "custom",
          "name": "awesome-custom-client",
          "language": "typescript",
          "customComponent": "./src/custom-test-component.js",
          "customType": "client"
      }
  ]
}
```
## Resources

- [@open-rpc/generator package](https://www.npmjs.com/package/@open-rpc/generator)
- [example open-rpc documents](https://github.com/open-rpc/examples/tree/master/service-descriptions)
npm package: @open-rpc/generator-client-js
Description: Multi-language client generators for [open-rpc](https://github.com/open-rpc/spec) apis.
Latest version: 1.0.24
Deprecated: PACKAGE MOVED TO @open-rpc/generator-client

# generator-client
Multi-language client generators for [open-rpc](https://github.com/open-rpc/spec) apis.

using npm:
```
npm install -g @open-rpc/generator-client
open-rpc-generator-client \
  -s https://raw.githubusercontent.com/open-rpc/examples/master/service-descriptions/petstore.json \
  PetStore
```
In action (for a js client):
```sh
docker run \
  -v $(pwd)/petstore/:/petstore \
  openrpc/generator-client-js \
    -s https://raw.githubusercontent.com/open-rpc/examples/master/service-descriptions/petstore.json
    petstore
```