Code Monkey home page Code Monkey logo

cocreate-app / cocreatews Goto Github PK

View Code? Open in Web Editor NEW
4.0 1.0 1.0 9.61 MB

Server Side for CoCreateJS. Containing websocket, crud, auth, server side rendering, and permission components.

Home Page: https://cocreate.app/docs/CoCreateWS

License: Other

Dockerfile 0.03% JavaScript 5.79% HTML 93.85% CSS 0.32%
cocreate cocreate-framework cocreatejs cocreatejs-component cocreatews collaboration collaborative-framework html5-framework javascript-framework low-code

cocreatews's Introduction

CoCreateWS

Server Side for CoCreateJS. Containing websocket, crud, auth, server side rendering, and permission components.

GitHub latest release GitHub contributors License Hiring


Table of Contents


Installation

NPM

$ npm i @cocreate/cocreatews

Yarn

$ 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

$ npm install

Yarn

$ 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

$ npm createdb

Yarn

$ yarn createdb

Start Server

npm

$ npm start

Yarn

$ yarn start

Testing with CoCreateJS clientside using HTML5 attribute api

HTML5 attribute api example

<!DOCTYPE html>
<html lang="en">

    <body class="padding:5px">

        <form collection="test" document_id="">
            <input placeholder="Name" name='firstname' class="floating-label">
            <h1 name='lastname'  contenteditable></h1>
        </form>

        <script>
            var config = {
                apiKey: '<apiKey from CoCreate.config.js>',
                organization_id: '<organization_id from CoCreate.config.js>',
                host: '<Your CoCreateWS domain>'
            };
        </script>
        <script src="/dist/CoCreate.js"></script>

    </body>
</html>

Javascript object api example

Paste in your browsers console

crud.readDocument({
    collection: "test",
    document_id: "",
});

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.

cocreatews's People

Contributors

andreasdecrinis avatar bharat-rajani avatar frankpagan avatar github-actions[bot] avatar jinxc-dev avatar jiuchen1986 avatar mijailr avatar semantic-release-bot avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

ajunlonglive

cocreatews's Issues

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.