Codux Help Center
Browse our articles to find the answers you need
Codux Online Playground
Codux is a powerful tool for creating and sharing interactive web components and boards. The Codux Online Playground is a web-based version of Codux that lets you share, access, and edit your local projects online with anyone in the world without the need to have Codux or any computer prerequisites preinstalled – just a browser!
The Codux Online Playground has most of the features of the desktop version, with a few exceptions:
- There's no connection to Git providers. You cannot sync your online changes with your git repository or switch branches.
- There's no Scripts panel. Since the editor is online, you can't run your node scripts in it, and some frameworks (like Next.js) will not work.
- It isn't persistent – your online changes will not be saved, and won't be there when you refresh. You also can't make changes in Codux on your desktop and see the changes in the online version (unless you republish the project to the same link), and vice versa.
- Projects that require a running local server will not work with the online editor.
Note:
Make sure that your project is in a public repository, because only public repositories are supported with Codux Online at this time. If you created a new project in Codux that you want to share, you'll have to first create a public repository for it. If it's a project opened from a private repository, you'll have to change its visibility to make it public.
Important!
Don't include anything sensitive in your GitHub repo, as the repository contents will be shared online. Please also keep in mind that this online editor is in its early stages of development, and may not have all the functionality and stability that you expect from our more robust and reliable desktop app. We appreciate your patience and understanding as we work to improve the online editor. Should you encounter any issues or bugs, please let us know so that we can address them.
Sharing Your Projects with Codux Online
To share your project online:
- Sync all your changes in Codux with your GitHub repository. Make sure that it's a public repo, because only public repos work with Codux Online at this time.
- Navigate to the Share option at the top of Codux.
- When you share a project for the first time, you will be prompted to accept our disclaimer. Following this, you will need to provide a name for the project link.
That's it! You'll be given a unique link for your project at web.codux.com that you can share with whomever you want.
Some Things to Note
To use the Codux Online Playground, you need to upload your local project to an online workspace. This will create a unique URL that you can share with anyone. However, please note the following risks and limitations:
- Anything you upload is public and available to anyone on the internet. You should not upload private or sensitive projects this way (we do respect .gitignore definitions for public repositories). To disable the sharing of a project, open your project's codux.config.json file, and add the following property:
"disableProjectSharing": true
- There is a repo size limitation of 100MB, and a file size limitation of 3MB each. If your project exceeds these limits, you will not be able to upload it.
- If you want to upload private projects and control access to them, please contact us. When available, this will be a premium service.
Important!
For the project to be shared, it must be a valid Node.js project. This means it requires a
package.json
file to hold various metadata relevant to the project. This file is used to give information to npm that allows it to identify the project as well as handle the project's dependencies. You can learn more about the package.json
file from the npm documentation.For browser requirements, refer here.
We hope you enjoy the Codux Online Playground. Feel free to reach out to us if you have any questions, feedback, or suggestions. Have fun and build cool things with Codux!
Was this article helpful?