{"id":19571426,"url":"https://github.com/torstendittmann/aw-test-realtime","last_synced_at":"2025-06-26T00:04:30.130Z","repository":{"id":132710519,"uuid":"373776213","full_name":"TorstenDittmann/aw-test-realtime","owner":"TorstenDittmann","description":null,"archived":false,"fork":false,"pushed_at":"2021-06-04T08:39:51.000Z","size":60,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-20T20:00:08.641Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TorstenDittmann.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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":"2021-06-04T08:37:59.000Z","updated_at":"2021-06-04T08:39:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"988be1e5-3f6b-4ddf-8724-f2092a9f4580","html_url":"https://github.com/TorstenDittmann/aw-test-realtime","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/TorstenDittmann/aw-test-realtime","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TorstenDittmann%2Faw-test-realtime","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TorstenDittmann%2Faw-test-realtime/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TorstenDittmann%2Faw-test-realtime/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TorstenDittmann%2Faw-test-realtime/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TorstenDittmann","download_url":"https://codeload.github.com/TorstenDittmann/aw-test-realtime/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TorstenDittmann%2Faw-test-realtime/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261973725,"owners_count":23238586,"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":[],"created_at":"2024-11-11T06:18:51.286Z","updated_at":"2025-06-26T00:04:30.103Z","avatar_url":"https://github.com/TorstenDittmann.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Appwrite Web SDK - Realtime Alpha\n\n![License](https://img.shields.io/github/license/appwrite/sdk-for-web.svg?style=flat-square)\n![Version](https://img.shields.io/badge/api%20version-0.8.0-blue.svg?style=flat-square)\n[![Twitter Account](https://img.shields.io/twitter/follow/appwrite_io?color=00acee\u0026label=twitter\u0026style=flat-square)](https://twitter.com/appwrite_io)\n[![Discord](https://img.shields.io/discord/564160730845151244?label=discord\u0026style=flat-square)](https://appwrite.io/discord)\n\n**WORK IN PROGRESS - NOT READY FOR PRODUCTION**\n\nAppwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way.\n                        Use the Web SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools.\n                        For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)\n\n![Appwrite](https://appwrite.io/images/github.png)\n\n## Installation\n\n### NPM\n\nTo install via [NPM](https://www.npmjs.com/):\n\n```bash\nnpm install appwrite --save\n```\n\nIf you're using a bundler (like [Rollup](https://rollupjs.org/) or [webpack](https://webpack.js.org/)), you can import the Appwrite module when you need it:\n\n```js\nimport { Appwrite } from \"appwrite\";\n```\n\n### CDN\n\nTo install with a CDN (content delivery network) add the following scripts to the bottom of your \u003cbody\u003e tag, but before you use any Appwrite services:\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/appwrite@3.0.5\"\u003e\u003c/script\u003e\n```\n\n\n## Getting Started\n\n### Add your Web Platform\nFor you to init your SDK and interact with Appwrite services you need to add a web platform to your project. To add a new platform, go to your Appwrite console, choose the project you created in the step before and click the 'Add Platform' button.\n\nFrom the options, choose to add a **Web** platform and add your client app hostname. By adding your hostname to your project platform you are allowing cross-domain communication between your project and the Appwrite API.\n\n### Init your SDK\nInitialize your SDK code with your project ID which can be found in your project settings page.\n\n```js\n// Init your Web SDK\nconst sdk = new Appwrite();\n\nsdk\n    .setEndpoint('http://localhost/v1') // Your Appwrite Endpoint\n    .setProject('455x34dfkj') // Your project ID\n;\n```\n\n### Make Your First Request\nOnce your SDK object is set, access any of the Appwrite services and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the API References section.\n\n```js\n// Register User\nsdk.account.create('me@example.com', 'password', 'Jane Doe')\n    .then(function (response) {\n        console.log(response);\n    }, function (error) {\n        console.log(error);\n    });\n\n```\n\n### Full Example\n```js\n// Init your Web SDK\nconst sdk = new Appwrite();\n\nsdk\n    .setEndpoint('http://localhost/v1') // Your Appwrite Endpoint\n    .setProject('455x34dfkj')\n;\n\n// Register User\nsdk.account.create('me@example.com', 'password', 'Jane Doe')\n    .then(function (response) {\n        console.log(response);\n    }, function (error) {\n        console.log(error);\n    });\n```\n\n### Learn more\nYou can use followng resources to learn more and get help\n- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-flutter)\n- 📜 [Appwrite Docs](https://appwrite.io/docs)\n- 💬 [Discord Community](https://appwrite.io/discord)\n- 🚂 [Appwrite Flutter Playground](https://github.com/appwrite/playground-for-flutter)\n\n\n## Contribution\n\nThis library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.\n\n## License\n\nPlease see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftorstendittmann%2Faw-test-realtime","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftorstendittmann%2Faw-test-realtime","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftorstendittmann%2Faw-test-realtime/lists"}