{"id":31536451,"url":"https://github.com/kdeary/ethermeris","last_synced_at":"2026-04-14T00:02:16.825Z","repository":{"id":57142651,"uuid":"349672340","full_name":"kdeary/Ethermeris","owner":"kdeary","description":"Real-time State Management Networking Framework for Node.js","archived":false,"fork":false,"pushed_at":"2021-06-15T00:44:33.000Z","size":1554,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-04T07:23:42.289Z","etag":null,"topics":["framework-javascript","javascript","nodejs","state-management","webrtc","websocket"],"latest_commit_sha":null,"homepage":"https://kdeary.github.io/Ethermeris/","language":"JavaScript","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/kdeary.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-20T08:46:53.000Z","updated_at":"2021-06-15T00:44:35.000Z","dependencies_parsed_at":"2022-09-05T11:50:22.853Z","dependency_job_id":null,"html_url":"https://github.com/kdeary/Ethermeris","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/kdeary/Ethermeris","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdeary%2FEthermeris","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdeary%2FEthermeris/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdeary%2FEthermeris/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdeary%2FEthermeris/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kdeary","download_url":"https://codeload.github.com/kdeary/Ethermeris/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdeary%2FEthermeris/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31776013,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T20:17:16.280Z","status":"ssl_error","status_checked_at":"2026-04-13T20:17:08.216Z","response_time":93,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["framework-javascript","javascript","nodejs","state-management","webrtc","websocket"],"created_at":"2025-10-04T07:17:33.058Z","updated_at":"2026-04-14T00:02:16.816Z","avatar_url":"https://github.com/kdeary.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Ethermeris\nA Real-time State Management Networking Framework for Node.js\n\n## Features\nEthermeris is a real-time networking framework that simplifies state management between the server and clients. It consists of:\n- A Node.js module for the server\n- A JavaScript client library for the browser\n\n### Main Features\nEthermeris is very similar to other networking frameworks but:\nEthermeris's main advantage is speed. \n\n**UDP Networking through WebRTC**\nEthermeris uses WebRTC to communicate between the server and clients to accomplish fast packet speeds. If WebRTC isn't supported on the browser, WebSockets is automatically used as a fallback.\n\n**Event Compression through MessagePack**\nEthermeris automatically compresses and decompress event data using MessagePack end-to-end. By compressing JSON objects into binary blobs, Ethermeris can achieve high speeds.\n\n**Built-in State Management**\nThe Ethermeris Server also provides a singular state that gets automatically synced with all clients intelligently. Currently, it is very restricting. There are some things to know about this state:\n- MessagePack converts undefined to null during encoding, so do not use undefined in the state.\n- Currently, to denote that a key should be deleted from the state, the value has to be set to null.\n- Because of the two points above, instead of using null to show emptiness of a value, use something else that's more fitting such as an empty string or false.\n- Arrays are not meant to be used within the state. Instead of holding collections of objects using arrays, use a normal object instead, and use the IDs of the objects as keys.\n\n**Custom Object Compression**\nNot implemented yet.\n\n## Installation\n```\n// with npm\nnpm install ethermeris\n\n// with yarn\nyarn add ethermeris\n```\n\n## Example Code\nThis example shows only the server code required.\n\nThis server code opens a server on port `3000` that's ready for clients and a counter that changes the state every second.\n```js\n// server.js\nconst http = require('http');\nconst Ethermeris = require('ethermeris');\nconst httpServer = http.Server(app);\n\nconst manager = new Ethermeris.Manager({\n\thttpServer\n});\nconst server = manager.createServer({\n\tserverID: \"main\",\n\tstateSchema: {\n\t\tcounter: 0\n\t}\n});\n\nserver.on('connection', (client, metadata) =\u003e {\n\tconsole.log(\"A user has joined!\");\n});\nserver.on('disconnection', client =\u003e {\n\tconsole.log(\"A user has disconnected.\");\n});\n\nsetInterval(() =\u003e {\n\tserver.setState(state =\u003e ({\n\t\tcounter: state.counter + 1\n\t}));\n}, 1000);\n\nhttpServer.listen(3000);\n```\nA more in-depth example is available in the `examples/setup` folder.\n\n## Documentation\nDocumentation is available here: [https://kdeary.github.io/Ethermeris](https://kdeary.github.io/Ethermeris/)\n\n## License\n[MIT](https://github.com/kdeary/Ethermeris/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkdeary%2Fethermeris","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkdeary%2Fethermeris","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkdeary%2Fethermeris/lists"}