Installations
npm install @cocreate/cocreatewsDeveloper Guide
Typescript
No
Module System
CommonJS
Node Version
20.18.0
NPM Version
10.8.2
Score
39.8
Supply Chain
55.2
Quality
81.8
Maintenance
100
Vulnerability
68.8
License
Releases
Contributors
Unable to fetch Contributors
Languages
JavaScript (99.21%)
Dockerfile (0.79%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
Download Statistics
Total Downloads
48,188
Last Day
13
Last Week
113
Last Month
398
Last Year
6,519
GitHub Statistics
5 Stars
844 Commits
1 Forks
1 Watching
8 Branches
7 Contributors
Maintainers
Package Meta Information
Latest Version
1.0.3
Package Id
@cocreate/cocreatews@1.0.3
Unpacked Size
172.84 kB
Size
45.46 kB
File Count
27
NPM Version
10.8.2
Node Version
20.18.0
Publised On
14 Dec 2024
Total Downloads
Cumulative downloads
Total Downloads
48,188
Last day
8.3%
13
Compared to previous day
Last week
4.6%
113
Compared to previous week
Last month
-22%
398
Compared to previous month
Last year
-74.5%
6,519
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
27
Dev Dependencies
5
CoCreateWS
Server Side for CoCreateJS. Containing websocket, crud, auth, server side rendering, and permission components.
Docs & Demo
Table of Contents
Installation
NPM
1$ npm i @cocreate/cocreatews
Yarn
1$ yarn add @cocreate/cocreatews
MongoDB
MongoDB 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.
MongoDB Atlas
https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/
MongoDB Local Install
https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/
Proxy Server
Use your prefered proxy server: nginx, apache, etc
https://domain.com/ forwarded to port 3000
wss://domain.com/ws/ forwarded to port 3000
Install NPM Dependencies
NPM
1$ npm install
Yarn
1$ yarn install
Create an organization and apiKey
In CoCreate.config.js add your organization and user data, then run createdb to create the first organization and user.
npm
1$ npm createdb
Yarn
1$ yarn createdb
Start Server
npm
1$ npm start
Yarn
1$ yarn start
Testing with CoCreateJS clientside using HTML5 attribute api
HTML5 attribute api example
1<!DOCTYPE html> 2<html lang="en"> 3 4 <body class="padding:5px"> 5 6 <form array="test" object=""> 7 <input placeholder="Name" name='firstname' class="floating-label"> 8 <h1 name='lastname' contenteditable></h1> 9 </form> 10 11 <script> 12 var config = { 13 apiKey: '<apiKey from CoCreate.config.js>', 14 organization_id: '<organization_id from CoCreate.config.js>', 15 host: '<Your CoCreateWS domain>' 16 }; 17 </script> 18 <script src="/dist/CoCreate.js"></script> 19 20 </body> 21</html>
Javascript object api example
Paste in your browsers console
1crud.readDocument({ 2 array: "test", 3 object: "", 4});
Announcements
All updates to this library are documented in our CHANGELOG and releases. You may also subscribe to email for releases and breaking changes.
Roadmap
If you are interested in the future direction of this project, please take a look at our open issues and pull requests. We would love to hear your feedback.
About
CoCreateWS is guided and supported by the CoCreate Developer Experience Team.
Please Email the Developer Experience Team here in case of any queries.
CoCreateWS is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.
How to Contribute
We encourage contribution to our libraries (you might even score some nifty swag), please see our CONTRIBUTING guide for details.
We 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 and pull requests or merely upvote or comment on existing issues or pull requests.
We appreciate your continued support, thank you!
License
This software is dual-licensed under the GNU Affero General Public License version 3 (AGPLv3) and a commercial license.
-
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.
-
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. 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.
If 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.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
0 existing vulnerabilities detected
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/automated.yml:54
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
3 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 2
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/automated.yml:1
- Warn: no topLevel permission defined: .github/workflows/dev.yml:1
- Warn: no topLevel permission defined: .github/workflows/manual.yml:1
- Info: no jobLevel write permissions found
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/automated.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/CoCreate-app/CoCreateWS/automated.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/automated.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/CoCreate-app/CoCreateWS/automated.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/automated.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/CoCreate-app/CoCreateWS/automated.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/automated.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/CoCreate-app/CoCreateWS/automated.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/automated.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/CoCreate-app/CoCreateWS/automated.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/automated.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/CoCreate-app/CoCreateWS/automated.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/automated.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/CoCreate-app/CoCreateWS/automated.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/automated.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/CoCreate-app/CoCreateWS/automated.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/dev.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/CoCreate-app/CoCreateWS/dev.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/manual.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/CoCreate-app/CoCreateWS/manual.yml/master?enable=pin
- Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating node:14-alpine to node:14-alpine@sha256:434215b487a329c9e867202ff89e704d3a75e554822e07f3e0c0f9e606121b33
- Warn: npmCommand not pinned by hash: Dockerfile:10
- Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 containerImage dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Score
4
/10
Last Scanned on 2025-02-03
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More