{"id":22777068,"url":"https://github.com/cocreate-app/cocreatews","last_synced_at":"2025-04-15T12:26:18.707Z","repository":{"id":49742137,"uuid":"314347978","full_name":"CoCreate-app/CoCreateWS","owner":"CoCreate-app","description":"Server Side for CoCreateJS. Containing websocket, crud, auth, server side rendering, and permission components.","archived":false,"fork":false,"pushed_at":"2024-12-14T23:18:28.000Z","size":9917,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-10T14:21:45.108Z","etag":null,"topics":["cocreate","cocreate-framework","cocreatejs","cocreatejs-component","cocreatews","collaboration","collaborative-framework","html5-framework","javascript-framework","low-code","low-code-framework","no-code","no-code-framework","realtime","realtime-framework","shared-editing"],"latest_commit_sha":null,"homepage":"https://cocreate.app/docs/CoCreateWS","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CoCreate-app.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","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},"funding":{"github":"CoCreate-app"}},"created_at":"2020-11-19T19:20:33.000Z","updated_at":"2025-01-10T10:39:03.000Z","dependencies_parsed_at":"2023-02-01T03:15:42.734Z","dependency_job_id":"98f97b76-26e6-45d1-bfd4-1b3ca5b9ad53","html_url":"https://github.com/CoCreate-app/CoCreateWS","commit_stats":{"total_commits":770,"total_committers":10,"mean_commits":77.0,"dds":0.3909090909090909,"last_synced_commit":"77fd7a3f55f78002097f7b1c3d0663c32edb6f7e"},"previous_names":[],"tags_count":249,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CoCreate-app%2FCoCreateWS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CoCreate-app%2FCoCreateWS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CoCreate-app%2FCoCreateWS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CoCreate-app%2FCoCreateWS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CoCreate-app","download_url":"https://codeload.github.com/CoCreate-app/CoCreateWS/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249070157,"owners_count":21207830,"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":["cocreate","cocreate-framework","cocreatejs","cocreatejs-component","cocreatews","collaboration","collaborative-framework","html5-framework","javascript-framework","low-code","low-code-framework","no-code","no-code-framework","realtime","realtime-framework","shared-editing"],"created_at":"2024-12-11T19:12:56.256Z","updated_at":"2025-04-15T12:26:18.686Z","avatar_url":"https://github.com/CoCreate-app.png","language":"JavaScript","readme":"# CoCreateWS\r\n\r\nServer Side for [CoCreateJS](https://github.com/CoCreate-app/CoCreateJS). Containing websocket, crud, auth, server side rendering, and permission components.\r\n\r\n![GitHub latest release](https://img.shields.io/github/v/release/CoCreate-app/CoCreateWS?style=flat-square)\r\n![GitHub contributors](https://img.shields.io/github/contributors/CoCreate-app/CoCreateWS?style=flat-square)\r\n![License](https://img.shields.io/static/v1?style=flat-square\u0026label=license\u0026message=SSPL\u0026color=green)\r\n![Hiring](https://img.shields.io/static/v1?style=flat-square\u0026label=\u0026message=Hiring\u0026color=blueviolet)\r\n\r\n## [Docs \u0026 Demo](https://cocreate.app/docs/CoCreateWS)\r\n\r\n\u003cbr/\u003e\r\n\r\n# Table of Contents\r\n\r\n-   [Table of Contents](#table-of-contents)\r\n-   [Announcements](#announcements)\r\n-   [Installation](#installation)\r\n-   [Roadmap](#roadmap)\r\n-   [How to Contribute](#how-to-contribute)\r\n-   [About](#about)\r\n-   [License](#license)\r\n\r\n\u003cbr/\u003e\r\n\r\n\u003ca name=\"installation\"\u003e\u003c/a\u003e\r\n\r\n# Installation\r\n\r\n## NPM\r\n\r\n```shell\r\n$ npm i @cocreate/cocreatews\r\n```\r\n\r\n## Yarn\r\n\r\n```shell\r\n$ yarn add @cocreate/cocreatews\r\n```\r\n\r\n\u003cbr/\u003e\r\n\r\n## MongoDB\r\n\r\nMongoDB URL is required in CoCreate.config.js param db_url to succesfully start the server. You can use the dbUrl generated by MongoDB atlas or a localhost url by installing MongoDB locally.\r\n\r\n### MongoDB Atlas\r\n\r\nhttps://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/\r\n\r\n### MongoDB Local Install\r\n\r\nhttps://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/\r\n\r\n\u003cbr/\u003e\r\n\r\n## Proxy Server\r\n\r\nUse your prefered proxy server: nginx, apache, etc\r\n\r\n#### https://domain.com/ forwarded to port 3000\r\n\r\n#### wss://domain.com/ws/ forwarded to port 3000\r\n\r\n\u003cbr/\u003e\r\n\r\n## Install NPM Dependencies\r\n\r\n### NPM\r\n\r\n```shell\r\n$ npm install\r\n```\r\n\r\n### Yarn\r\n\r\n```shell\r\n$ yarn install\r\n```\r\n\r\n\u003cbr/\u003e\r\n\r\n## Create an organization and apiKey\r\n\r\nIn CoCreate.config.js add your organization and user data, then run createdb to create the first organization and user.\r\n\r\n### npm\r\n\r\n```shell\r\n$ npm createdb\r\n```\r\n\r\n### Yarn\r\n\r\n```shell\r\n$ yarn createdb\r\n```\r\n\r\n\u003cbr/\u003e\r\n\r\n## Start Server\r\n\r\n### npm\r\n\r\n```shell\r\n$ npm start\r\n```\r\n\r\n### Yarn\r\n\r\n```shell\r\n$ yarn start\r\n```\r\n\r\n\u003cbr/\u003e\r\n\r\n## Testing with CoCreateJS clientside using HTML5 attribute api\r\n\r\n### HTML5 attribute api example\r\n\r\n```HTML\r\n\u003c!DOCTYPE html\u003e\r\n\u003chtml lang=\"en\"\u003e\r\n\r\n    \u003cbody class=\"padding:5px\"\u003e\r\n\r\n        \u003cform array=\"test\" object=\"\"\u003e\r\n            \u003cinput placeholder=\"Name\" name='firstname' class=\"floating-label\"\u003e\r\n            \u003ch1 name='lastname'  contenteditable\u003e\u003c/h1\u003e\r\n        \u003c/form\u003e\r\n\r\n        \u003cscript\u003e\r\n            var config = {\r\n                apiKey: '\u003capiKey from CoCreate.config.js\u003e',\r\n                organization_id: '\u003corganization_id from CoCreate.config.js\u003e',\r\n                host: '\u003cYour CoCreateWS domain\u003e'\r\n            };\r\n        \u003c/script\u003e\r\n        \u003cscript src=\"/dist/CoCreate.js\"\u003e\u003c/script\u003e\r\n\r\n    \u003c/body\u003e\r\n\u003c/html\u003e\r\n```\r\n\r\n\u003cbr/\u003e\r\n\r\n### Javascript object api example\r\n\r\nPaste in your browsers console\r\n\r\n```js\r\ncrud.readDocument({\r\n    array: \"test\",\r\n    object: \"\",\r\n});\r\n```\r\n\r\n\u003cbr/\u003e\r\n\r\n\u003ca name=\"announcements\"\u003e\u003c/a\u003e\r\n\r\n# Announcements\r\n\r\nAll updates to this library are documented in our [CHANGELOG](https://github.com/CoCreate-app/CoCreateWS/blob/master/CHANGELOG.md) and [releases](https://github.com/CoCreate-app/CoCreateWS/releases). You may also subscribe to email for releases and breaking changes.\r\n\r\n\u003cbr/\u003e\r\n\r\n\u003ca name=\"roadmap\"\u003e\u003c/a\u003e\r\n\r\n# Roadmap\r\n\r\nIf you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/CoCreate-app/CoCreateWS/issues) and [pull requests](https://github.com/CoCreate-app/CoCreateWS/pulls). We would love to hear your feedback.\r\n\r\n\u003cbr/\u003e\r\n\r\n\u003ca name=\"about\"\u003e\u003c/a\u003e\r\n\r\n# About\r\n\r\nCoCreateWS is guided and supported by the CoCreate Developer Experience Team.\r\n\r\nPlease Email the Developer Experience Team [here](mailto:develop@cocreate.app) in case of any queries.\r\n\r\nCoCreateWS is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.\r\n\r\n\u003cbr/\u003e\r\n\r\n\u003ca name=\"contribute\"\u003e\u003c/a\u003e\r\n\r\n# How to Contribute\r\n\r\nWe encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/CoCreate-app/CoCreateWS/blob/master/CONTRIBUTING.md) guide for details.\r\n\r\nWe want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/CoCreate-app/CoCreateWS/issues) and [pull requests](https://github.com/CoCreate-app/CoCreateWS/pulls) or merely upvote or comment on existing issues or pull requests.\r\n\r\nWe appreciate your continued support, thank you!\r\n\r\n\u003cbr/\u003e\r\n\r\n\u003ca name=\"license\"\u003e\u003c/a\u003e\r\n\r\n# License\r\n\r\nThis software is dual-licensed under the GNU Affero General Public License version 3 (AGPLv3) and a commercial license.\r\n\r\n-   **Open Source Use**: For open-source projects and non-commercial use, this software is available under the AGPLv3. The AGPLv3 allows you to freely use, modify, and distribute this software, provided that all modifications and derivative works are also licensed under the AGPLv3. For the full license text, see the [LICENSE file](https://github.com/CoCreate-app/CoCreateWS/blob/master/LICENSE).\r\n\r\n-   **Commercial Use**: For-profit companies and individuals intending to use this software for commercial purposes must obtain a commercial license. The commercial license is available when you sign up for an API key on our [website](https://cocreate.app). This license permits proprietary use and modification of the software without the copyleft requirements of the AGPLv3. It is ideal for integrating this software into proprietary commercial products and applications.\r\n\r\nIf you have not purchased a commercial license and intend to use this software for commercial purposes, you are required to sign up for an API key on our website.\r\n","funding_links":["https://github.com/sponsors/CoCreate-app"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcocreate-app%2Fcocreatews","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcocreate-app%2Fcocreatews","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcocreate-app%2Fcocreatews/lists"}