{"id":29840595,"url":"https://github.com/graphform/swim-runtime-js","last_synced_at":"2025-07-29T14:17:18.336Z","repository":{"id":97910169,"uuid":"197240278","full_name":"graphform/swim-runtime-js","owner":"graphform","description":"Frameworks for building massively real-time streaming WARP client applications.","archived":false,"fork":false,"pushed_at":"2023-11-09T21:34:51.000Z","size":7098,"stargazers_count":5,"open_issues_count":1,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-23T03:54:31.559Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://swimos.org","language":"TypeScript","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/graphform.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"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}},"created_at":"2019-07-16T17:39:17.000Z","updated_at":"2025-06-20T22:21:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"d08689ca-5c1f-48bf-a373-05dabf9444d7","html_url":"https://github.com/graphform/swim-runtime-js","commit_stats":null,"previous_names":["graphform/swim-runtime-js"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/graphform/swim-runtime-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fswim-runtime-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fswim-runtime-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fswim-runtime-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fswim-runtime-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/graphform","download_url":"https://codeload.github.com/graphform/swim-runtime-js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphform%2Fswim-runtime-js/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267701685,"owners_count":24130458,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2025-07-29T14:16:46.080Z","updated_at":"2025-07-29T14:17:18.328Z","avatar_url":"https://github.com/graphform.png","language":"TypeScript","readme":"# \u003ca href=\"https://www.swimos.org\"\u003e\u003cimg src=\"https://docs.swimos.org/readme/breach-marlin-blue-wide.svg\"\u003e\u003c/a\u003e Swim TypeScript Runtime\n\nThe Swim frontend runtime provides foundation frameworks for building massively\nreal-time streaming applications. The runtime provides applications with:\n\n- **Modern Foundation:** Dependency-free, 100% TypeScript foundation framework\n  for Node.js and browser apps.\n- **Shared States:** Multiplexed streaming API client for continuously\n  synchronizing real-time shared states with backend Web Agents.\n\n## Documentation\n\n- [API Docs][api-docs]\n\n## Usage\n\n#### npm\n\n```sh\nnpm install @swim/runtime\n```\n\n#### browser\n\n```html\n\u003c!-- Development --\u003e\n\u003cscript src=\"https://cdn.swimos.org/js/4.x/swim-runtime.js\"\u003e\u003c/script\u003e\n\n\u003c!-- Production --\u003e\n\u003cscript src=\"https://cdn.swimos.org/js/4.x/swim-runtime.min.js\"\u003e\u003c/script\u003e\n```\n\n## Development\n\n#### Build environment\n\nInstall build dependencies:\n\n```sh\nnpm install\n```\n\n#### Build script\n\nThe Swim TypeScript stack is compiled using a custom build script.\nBefore building the stack, first bootstrap the build script.\n\n```sh\nnpm run bootstrap\n```\n\nUse `npx swim-build` to execute build commands:\n\n```sh\nnpx swim-build help # prints build script usage instructions\nnpx swim-build pkgs # lists buildable packages\n```\n\n#### Compiling sources\n\nThe default `swim-build` command will compile, lint, api-extract, and bundle\nTypeScript sources. To compile all libraries, of all packages, run:\n\n```sh\nnpx swim-build\n```\n\nTo compile a subset of packages, include a `--pkgs` (`-p`) option followed\nby a comma-separated list of package names. For example, to build the `core`\npackage, run:\n\n```sh\nnpx swim-build -p core\n```\n\n#### Running tests\n\nThe `test` subcommand reruns unit tests. For example, to compile and test\nthe `core` package and its dependencies, run:\n\n```sh\nnpx swim-build test -p core -r\n```\n\n#### Continuous development builds\n\nThe `watch` subcommand automatically rebuilds packages when dependent files\nchange. For example, to continuously build the `host` package, run:\n\n```sh\nnpx swim-build watch -p host\n```\n\n#### Generating documentation\n\nThe `doc` subcommand generates API documentation:\n\n```sh\nnpx swim-build doc -p runtime\n```\n\n## Contributing\n\nTake a look at the [Contributing Guide][contributing] to learn about our\nsubmission process, coding standards, and more.\n\n[api-docs]: https://docs.swimos.org/js/4.x/modules/_swim_runtime.html\n[contributing]: CONTRIBUTING.md\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphform%2Fswim-runtime-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgraphform%2Fswim-runtime-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphform%2Fswim-runtime-js/lists"}