decodeproject/zenroom-studio

Zenroom Studio is an extensible IDE which targets multiple platforms :electron: designed specifically for Zenroom/Zencode development

Zenroom Studio

Zenroom Studio is a multiplatform (Gnu+Linux, Windows, macOS) IDE designed specifically to work with Zenroom

The main use case for Zenroom is that of distributed computing of untrusted code where advanced cryptographic functions are required, for instance it can be used as a distributed ledger implementation (also known as blockchain smart contracts).

Zenroom and Zenroom Studio are software in ALPHA stage and are part of the DECODE project about data-ownership and technological sovereignty. Our effort is that of improving people's awareness of how their data is processed by algorithms, as well facilitate the work of developers to create along privacy by design principles using algorithms that can be deployed in any situation without any change.

🚩 Table of Contents (click to expand)

• Installation
• Usage
• Configuration
• Notes
• Troubleshooting & debugging
• Acknowledgements
• License

---

💾 Installation

Desktop binaries

To install in on yout desktop please download the following released binaries for you platform on the release page

Development

For developers the easiest way to get up and running is:

1. Checkout and install all the dependencies

git clone https://github.com/DECODEproject/zenroom-studio.git
cd zenroom-studio
yarn

2. Run Zenroom Studio

yarn start

---

🎮 Usage

---

🔧 Configuration

As for now the software has no configuration. They are planned soon to be added, as soon as they are available all the options will be listed here.

---

📝 Notes

Packaging

To build the packages for your platform there are some commands available listed below. Please note that in order to build the windows executable you need Wine installed and configured, and for build the mac .dmg package you need to run the command on a macOS operating system.

🍎 macOS

yarn package-mac

🐧 Gnu+Linux

yarn package-linux

🏁 Windows

yarn package-win

To build all platforms

yarn package-all

Linting

All the code is configured to be linted with ESLint. So especially for new code contributions is preferrable to run and fix the lint suggestions.

Javascript

• Run the linter yarn lint

• Automagically fix lint suggestions yarn lint-fix

CSS

• Run the linter yarn lint-styles

• Automagically fix lint suggestions yarn lint-styles-fix

---

🐛 Troubleshooting & debugging

Debug mode

To run Zenroom Studio in debug mode you'll need first to install it on your local machine following the instructions listed in Installation#Development and after run

yarn run dev

This will enable the inspector in electron/chrome and gives you more verbose output on the console.

Common problems

• error [email protected]: The engine "node" is incompatible with this module. Expected version "^6.14.0 || ^8.10.0 || >=9.10.0". You need to upgrade you node version to a newer version. Take a look here.

---

😍 Acknowledgements

Copyright (C) 2018 by Dyne.org foundation, Amsterdam

Designed, written and maintained by Puria Nafisi Azizi.

Special thanks to Federico Bonelli and Jaromil for their expert reviews.

This software used as a starting point the awesome electron react boilerplate by @chentsulin

This project is receiving funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement nr. 732546 (DECODE).

---

💼 License

Zenroom Studio. The Zencode IDE

Copyright (C) 2018  Dyne.org foundation, Amsterdam

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

zenroom-studio's Issues

An in-range update of webpack is breaking the build 🚨

The devDependency webpack was updated from 4.19.0 to 4.19.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

webpack is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ✅ continuous-integration/travis-ci/push: The Travis CI build passed (Details).
• ❌ continuous-integration/appveyor/branch: AppVeyor build failed (Details).

---

Release Notes for v4.19.1

Bugfixes

• Internal requested filename for import() with target: "electron-main" uses correct path separator on windows
  (This fixes a problem with filemappings in vscode)
• devtool: "source-map" and variants generate SourceMaps when output file is .mjs
• browser field as object is used when using target: "electron-renderer"
• Comments near export default are preserved
• Passing an array as externals value, now works correctly as documented

Commits

The new version differs by 15 commits.

• b7121c1 4.19.1
• ab28497 Merge pull request #8043 from RubenVerborgh/externals-object-array
• 9bda629 remove bad unit test
• f0271d9 fix ExternalModule and test case
• 3aef0e5 Allow array as value in externals object.
• 7b91fa6 Merge pull request #8042 from webpack/bugfix/comments-export-default
• e08f71c keep/restore comments in export default
• 2f78aae Merge pull request #8038 from sharang-d/patch-5
• bb4c2d1 Correctly set the 'browser' value for electron-renderer
• 5ade574 Merge pull request #7947 from philipwalton/mjs-sourcemap-support
• 5258471 Merge pull request #8035 from kwonoj/fix-path
• 2df7b0c fix(nodemaintemplate): resolve async chunk path platform agnostic
• 17fafd3 Fix lint errors
• a2cc031 Add tests for default source map extensions
• 12762ff Add sourcemap support for .mjs output files

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

An in-range update of react-hot-loader is breaking the build 🚨

The dependency react-hot-loader was updated from 4.3.10 to 4.3.11.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

react-hot-loader is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Status Details

• ✅ continuous-integration/travis-ci/push: The Travis CI build passed (Details).
• ❌ continuous-integration/appveyor/branch: AppVeyor build failed (Details).

---

Release Notes for v4.3.11

Bug fixes

• hot fixing ES5 literals in index.js, introduced in 4.3.10 (80f6b63)

Commits

The new version differs by 2 commits.

• 28bab4c chore(release): 4.3.11
• 80f6b63 fix: hot fixing ES5 literals in index.js

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

An in-range update of react is breaking the build 🚨

There have been updates to the react monorepoundefined

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

This monorepo update includes releases of one or more dependencies which all belong to the react group definition.

react is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ✅ continuous-integration/travis-ci/push: The Travis CI build passed (Details).
• ❌ continuous-integration/appveyor/branch: AppVeyor build failed (Details).

---

Release Notes for v16.5.2

React DOM

• Fixed a recent <iframe> regression (@JSteunou in #13650)
• Fix updateWrapper so that <textarea>s no longer re-render when data is unchanged (@joelbarbosa in #13643

Schedule (Experimental)

• Renaming "tracking" API to "tracing" (@bvaughn in #13641)
• Add UMD production+profiling entry points (@bvaughn in #13642)
• Refactored schedule to remove some React-isms and improve performance for when deferred updates time out (@acdlite in #13582)

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.