open-index/open-npm huggingface dataset:
npm package: @operational.co/sdk
Description: Operational's node.js sdk relies on axios internally.
Author: Shashwat Amin
Latest version: 0.2.7

# Operational node.js sdk

Operational's node.js sdk relies on axios internally.

## How to build

Clone this package and run `npm install` to install dependencies.

Then run `npm run build` inside the package to generate build files.

This will generate /build/index.es.js and /build/index.umd.js

## How to install

Open terminal and run `npm install --save @operational.co/sdk` inside your node.js project.

## API docs

For docs, refer to https://operational.co/api
npm package: @operational/blocks
Description: Opinionated composed ui components
Author: Peter Szerzo
Latest version: 0.1.2

# Operational UI Blocks

<!-- separator -->

The `@operational/blocks` package builds on [@operational/components](https://github.com/Contiamo/operational-ui/tree/master/packages/components), delivering larger, opinionated pieces of UI that handle a fair bit of their own state or side effects.

## Getting Started

Install the package via npm or yarn:

`npm install @operational/blocks @operational/components`

It is likely you will be using blocks together with components, so we recommend installing them together.

Create your first `Filter` block-based application like so:

```js
import React from "react"
import { Filter } from "@operational/blocks"
import { Input, ThemeProvider, operationalTheme } from "@operational/components"

const App = () => {
  <ThemeProvider theme={operationalTheme}>
    <Filter>
      <Input id="field-1" value="Value 1" />
      <Input id="field-2" value="Value 2" />
      <DatePicker id="field-3" start="01-01-2018" />
    </Filter>
  </ThemeProvider>
}
```

This component interacts smoothly with data input components from `@operational/components` to render a filter summary, and add the fields themselves into a modal. See more at the [filter documentation page](http://ui.contiamo.com/blocks/filters).

<!-- separator -->

## Documentation

Head to the blocks section of the [documentation site](https://ui.contiamo.com/blocks) to see what you can do with blocks.
npm package: @operational/styleguide
Description: This project serves as the living styleguide to [@operational/components](https://github.com/contiamo/operational-ui). It is TypeScript-first and uses the [Monaco editor](https://microsoft.github.io/monaco-editor/) that powers [Visual Studio Code](https:/
Latest version: 0.1.2

# `@operational/styleguide`

This project serves as the living styleguide to [@operational/components](https://github.com/contiamo/operational-ui). It is TypeScript-first and uses the [Monaco editor](https://microsoft.github.io/monaco-editor/) that powers [Visual Studio Code](https://code.visualstudio.com/) to provide type-safe playgrounds for components, reading them from any given component library.

There's a good chance that you can create a living styleguide for _your_ TypeScript design system with `@operational/styleguide`.

## Getting Started

Here's how you can try out `@operational/styleguide`.

### Prerequisites

This tool uses a _source folder_ as a source of truth. It does not concern itself with the rest of your project, but components that you intend to export are required to be structured the following way _inside_ of any given source folder.

```bash
anything-can-happen-outside-of-src
src
├── ComponentName
│   ├── ComponentName.tsx
│   └── README.md
├── OtherComponentName
│   ├── OtherComponentName.tsx
│   └── README.md
└── index.tsx # <- this exports all the components
```

The reason for this requirement is that we have found that it scales quite well. As with any open source project, this is up for discussion, collaboration and improvement. [Open an issue](https://github.com/contiamo/operational-styleguide/issues/new) to start collaborating.

### Installation

> ⚠️ These instructions are where we want to be. The `src` path is not yet configurable.

Install `@operational/styleguide` by running `yarn add @operational/styleguide -D`.

Once installed, run `yarn operational-styleguide start ./path/to/your/src` and you will have a development server up and running. To build your styleguide for production, run `yarn operational-styleguide build ./path/to/your/src`. The final artifacts will be in a `dist` folder at your project root, ready to be served.

The `./path/to/your/src` defaults to `PROJECT_ROOT/src` and _can be omitted_ if your project is already structured this way.

For convenience, consider aliasing the `operational-styleguide` (`start`, `build`, etc.) by adding scripts to your `package.json`.

```diff
{
  "name": "@operational/styleguide",
  "scripts": {
+   "start": "operational-styleguide start",
+   "build": "operational-styleguide build",
  }
}
```

## Contributing

We love TypeScript. We love community. [Open an issue](https://github.com/contiamo/operational-styleguide/issues/new) with whatever's on your mind to start contributing.