Git Product home page Git Product logo

chokibro's Introduction

Chokibro

Watch a folder on the system and broadcast change event in realtime to the spacebro galaxy. The spacebro server serves on http the media which has been: add, change, or delete/unlink

Super useful to automatically:

  • ๐Ÿ–ผ upload media to a remote service
  • ๐ŸŽฅ create automated post-production process
  • ๐Ÿ‘‚ listen for file uploads on a ftp folder
  • ๐Ÿค– anything a bot could be good at

It emits a message which looks like this:

{
    namespace: String (name-with-dash),
    src: String (URI format),
    path: String (file path)
}

๐ŸŒ Installation

Since, we remove mediaInfo in favor of ffprobe, you should be able to use the package as is. We use @ffprobe-installer/ffprobe to install ffprobe with the correct binary. If you encounter some difficulies, make sure ffmpeg is installed.

Use npm i to install dependencies.

โš™ Configuration

The settings follow standard-settings format. You can change them to fit your needs:

{
  "server":{
    "port": 36400
  },
  "service": {
    "spacebro": {
      "host": "spacebro.space",
      "port": 3333,
      "client": {
        "name": "chokibro",
        "description": "Tool to watch a folder and send new media added in folder",
				"out": {
					"outMedia": {
						"eventName": "outMedia",
						"description": "New media added in folder tracked by chokibro",
						"type": "all"
					},
					"unlinkMedia": {
						"eventName": "unlink-media",
						"description": "Media removed in folder tracked by chokibro",
						"type": "all"
					}
        }
      },
      "channelName": "info-stream"
    }
  },
  "folder": "./assets",
  "checkIntegrity": false,
}

๐Ÿ‘‹ Usage

  1. Start spacebro in a terminal window: spacebro

  2. Start chokibro: npm run start

By default, chokibro is listening for the assets folder and exposes it over a static file server at the ipv4 available address on the 6161 port.

  1. Drag and drop a file into the assets folder. See how spacebro reports the event.

๐Ÿ“ฆ Dependencies

  • chokidar
  • finalhandler
  • ip
  • ffprobe
  • portfinder
  • serve-static
  • spacebro-client
  • standard-settings

๐Ÿ•ณ Troubleshooting

All the help you can provide to avoid falling in a trap or a black hole.

โค๏ธ Contribute

Explain how to contribute to the project

chokibro's People

Contributors

gabrielstuff avatar poignardazur avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

poignardazur

chokibro's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.