{"id":13393556,"url":"https://github.com/chrisjpatty/flume","last_synced_at":"2025-05-14T00:09:42.201Z","repository":{"id":37700574,"uuid":"244108214","full_name":"chrisjpatty/flume","owner":"chrisjpatty","description":"Extract logic from your apps with a user-friendly node editor powered by React.","archived":false,"fork":false,"pushed_at":"2025-03-23T00:14:38.000Z","size":8469,"stargazers_count":1533,"open_issues_count":87,"forks_count":151,"subscribers_count":36,"default_branch":"master","last_synced_at":"2025-05-06T05:06:32.172Z","etag":null,"topics":["flume","javascript","node","react"],"latest_commit_sha":null,"homepage":"https://flume.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chrisjpatty.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-03-01T07:46:21.000Z","updated_at":"2025-05-04T12:15:04.000Z","dependencies_parsed_at":"2025-04-13T20:28:04.726Z","dependency_job_id":null,"html_url":"https://github.com/chrisjpatty/flume","commit_stats":null,"previous_names":[],"tags_count":41,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisjpatty%2Fflume","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisjpatty%2Fflume/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisjpatty%2Fflume/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisjpatty%2Fflume/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrisjpatty","download_url":"https://codeload.github.com/chrisjpatty/flume/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254044195,"owners_count":22005100,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flume","javascript","node","react"],"created_at":"2024-07-30T17:00:55.893Z","updated_at":"2025-05-14T00:09:37.612Z","avatar_url":"https://github.com/chrisjpatty.png","language":"TypeScript","funding_links":[],"categories":["JavaScript","Javascript Libraries","TypeScript"],"sub_categories":["Misc"],"readme":"![](https://raw.githubusercontent.com/chrisjpatty/flume/master/logo.png?token=ADRZXI4TFKM3FXBEBQHQURK6QIJ6Q)\n\n[![NPM](https://img.shields.io/npm/v/flume.svg)](https://www.npmjs.com/package/flume) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [![Minzip Size](https://badgen.net/bundlephobia/minzip/flume)](https://bundlephobia.com/result?p=flume)\n\n# Flume\n\n## Guides \u0026 Examples\n\n[flume.dev](https://flume.dev)\n\n## Install\n\n```bash\nnpm install --save flume\n```\n\n## Usage\n\n### Defining your nodes\n\nImport `FlumeConfig` and use it to define the nodes and ports that will make up your node editor.\n\n```jsx\nimport { FlumeConfig, Controls, Colors } from \"flume\";\n\nconst flumeConfig = new FlumeConfig()\n\nflumeConfig\n  .addPortType({\n    type: \"number\",\n    name: \"number\",\n    label: \"Number\",\n    color: Colors.red,\n    controls: [\n      Controls.number({\n        name: \"num\",\n        label: \"Number\"\n      })\n    ]\n  })\n  .addNodeType({\n    type: \"number\",\n    label: \"Number\",\n    initialWidth: 150,\n    inputs: ports =\u003e [\n      ports.number()\n    ],\n    outputs: ports =\u003e [\n      ports.number()\n    ]\n  })\n  .addNodeType({\n    type: \"addNumbers\",\n    label: \"Add Numbers\",\n    initialWidth: 150,\n    inputs: ports =\u003e [\n      ports.number({name: \"num1\"}),\n      ports.number({name: \"num2\"})\n    ],\n    outputs: ports =\u003e [\n      ports.number({name: \"result\"})\n    ]\n  })\n```\n\n### Rendering the node editor\n\nTo render the node editor, import `NodeEditor` and pass it your nodeTypes and portTypes from the configuration you created.\n\n```jsx\nimport React from 'react'\nimport { NodeEditor } from 'flume'\nimport config from './config'\n\nconst App = () =\u003e {\n\n  return (\n    \u003cdiv style={{width: 600, height: 800}}\u003e // Give the wrapper a width \u0026 height\n      \u003cNodeEditor\n        nodeTypes={config.nodeTypes}\n        portTypes={config.portTypes}\n      /\u003e\n    \u003c/div\u003e\n  )\n}\n```\n\nFor more complete documentation visit: [flume.dev](https://flume.dev)\n\n## License\n\nMIT © [chrisjpatty](https://github.com/chrisjpatty)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisjpatty%2Fflume","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrisjpatty%2Fflume","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisjpatty%2Fflume/lists"}