# falcor-postman

> A graphical interactive in-browser Falcor queries validator IDE.

Latest version **2.0.0** (published 2016-11-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install falcor-postman
pnpm add falcor-postman
yarn add falcor-postman
bun add falcor-postman
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2016-11-09 |
| First published | 2016-10-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | big-mars Team |
| Maintainers | mattiaerre, nickbalestra |
| Keywords | Falcor, graphical, GUI, IDE, in-browser, interactive, queries, react, react-component, validator |

## Links

- npm: https://www.npmjs.com/package/falcor-postman
- Repository: https://github.com/opentable/falcor-postman
- Homepage: https://github.com/opentable/falcor-postman#readme
- Issues: https://github.com/opentable/falcor-postman/issues
- npm.io page: https://npm.io/package/falcor-postman

## Dependencies (8)

- [path](https://npm.io/package/path.md) ^0.12.7
- [lockr](https://npm.io/package/lockr.md) ^0.8.4
- [react](https://npm.io/package/react.md) ^15.3.1
- [falcor](https://npm.io/package/falcor.md) ^0.1.17
- [express](https://npm.io/package/express.md) ^4.14.0
- [react-dom](https://npm.io/package/react-dom.md) ^15.3.1
- [react-codemirror](https://npm.io/package/react-codemirror.md) ^0.2.6
- [falcor-http-datasource](https://npm.io/package/falcor-http-datasource.md) ^0.1.3

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2016-11-09
- 1.2.0 — 2016-11-08
- 1.0.1 — 2016-10-21
- 1.0.0-rc.4 — 2016-10-21
- 1.0.0-rc.3 — 2016-10-21
- 1.0.0-rc.2 — 2016-10-21
- 1.0.0-rc.1 — 2016-10-21
- 1.0.0-beta.2 — 2016-10-21
- 1.0.0-beta.1 — 2016-10-21

## README

# falcor-postman

A graphical interactive in-browser [Falcor](https://netflix.github.io/falcor/) queries validator IDE.

## Usage

Npm install using the following command:

```
npm install --save falcor-postman
```

And use it inside your Express app:

```javascript
const falcorPostman = require('falcor-postman');

const app = express();

const options = { middlewarePath: '/falcor-postman', falcorModelPath: '/model.json', app };

app.use(falcorPostman(options));
```

Where **options** is an object with the following properties:

name|type|description|default
---|---|---|---|---
middlewarePath|_string_|Optional: path used to serve the falcor-postman app|'/falcor-postman'|
falcorModelPath|_string_|Optional: falcor model path|'/model.json'|
app|_object_|The instance of your Express.js app|app

## UI

![falcor-postman UI](falcor-postman-ui.png "falcor-postman UI")

> Query: `[["metrosById", [201], ["name"]]]`

## Example

Clone or download this GitHub repository then run the example app using the following npm commands:

```
npm install

npm run start
```

> You should be able to open your browser and see the middleware running at the following URL: [http://127.0.0.1:3000/falcor-postman](http://127.0.0.1:3000/falcor-postman)

---
_Source: https://npm.io/package/falcor-postman · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._