{"id":22126157,"url":"https://github.com/soixantecircuits/chokibro","last_synced_at":"2025-03-24T08:18:24.969Z","repository":{"id":4993518,"uuid":"49518442","full_name":"soixantecircuits/chokibro","owner":"soixantecircuits","description":"chokibro watch and share folder event within the spacebro galaxy","archived":false,"fork":false,"pushed_at":"2022-12-11T05:24:54.000Z","size":622,"stargazers_count":0,"open_issues_count":20,"forks_count":1,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-04T17:50:30.664Z","etag":null,"topics":["folder-tooling","realtime","spacebro","watch"],"latest_commit_sha":null,"homepage":"https://spacebro.space","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/soixantecircuits.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-01-12T17:55:03.000Z","updated_at":"2020-02-03T22:54:40.000Z","dependencies_parsed_at":"2023-01-13T13:19:44.414Z","dependency_job_id":null,"html_url":"https://github.com/soixantecircuits/chokibro","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soixantecircuits%2Fchokibro","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soixantecircuits%2Fchokibro/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soixantecircuits%2Fchokibro/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soixantecircuits%2Fchokibro/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/soixantecircuits","download_url":"https://codeload.github.com/soixantecircuits/chokibro/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245232933,"owners_count":20581704,"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":["folder-tooling","realtime","spacebro","watch"],"created_at":"2024-12-01T16:51:24.823Z","updated_at":"2025-03-24T08:18:24.944Z","avatar_url":"https://github.com/soixantecircuits.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Chokibro\n\nWatch 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`\n\nSuper useful to automatically:\n  - 🖼 upload media to a remote service\n  - 🎥 create automated post-production process\n  - 👂 listen for file uploads on a ftp folder\n  - 🤖 anything a bot could be good at\n\nIt emits a message which looks like this:\n\n```\n{\n    namespace: String (name-with-dash),\n    src: String (URI format),\n    path: String (file path)\n}\n```\n\n## 🌍 Installation\n\nSince, 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.\n\nUse `npm i` to install dependencies.\n\n## ⚙ Configuration\n\nThe settings follow [standard-settings](https://github.com/soixantecircuits/standard-settings) format. You can change them to fit your needs:\n\n```\n{\n  \"server\":{\n    \"port\": 36400\n  },\n  \"service\": {\n    \"spacebro\": {\n      \"host\": \"spacebro.space\",\n      \"port\": 3333,\n      \"client\": {\n        \"name\": \"chokibro\",\n        \"description\": \"Tool to watch a folder and send new media added in folder\",\n\t\t\t\t\"out\": {\n\t\t\t\t\t\"outMedia\": {\n\t\t\t\t\t\t\"eventName\": \"outMedia\",\n\t\t\t\t\t\t\"description\": \"New media added in folder tracked by chokibro\",\n\t\t\t\t\t\t\"type\": \"all\"\n\t\t\t\t\t},\n\t\t\t\t\t\"unlinkMedia\": {\n\t\t\t\t\t\t\"eventName\": \"unlink-media\",\n\t\t\t\t\t\t\"description\": \"Media removed in folder tracked by chokibro\",\n\t\t\t\t\t\t\"type\": \"all\"\n\t\t\t\t\t}\n        }\n      },\n      \"channelName\": \"info-stream\"\n    }\n  },\n  \"folder\": \"./assets\",\n  \"checkIntegrity\": false,\n}\n```\n\n## 👋 Usage\n\n1. Start spacebro in a terminal window: `spacebro`\n\n2. Start chokibro: `npm run start`\n\nBy 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.\n\n3. Drag and drop a file into the assets folder. See how spacebro reports the event.\n\n\n## 📦 Dependencies\n\n- chokidar\n- finalhandler\n- ip\n- ffprobe\n- portfinder\n- serve-static\n- spacebro-client\n- standard-settings\n\n## 🕳 Troubleshooting\n\nAll the help you can provide to avoid falling in a trap or a black hole.\n\n## ❤️ Contribute\n\nExplain how to contribute to the project\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoixantecircuits%2Fchokibro","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoixantecircuits%2Fchokibro","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoixantecircuits%2Fchokibro/lists"}