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)
To install in on yout desktop please download the following released binaries for you platform on the release page
For developers the easiest way to get up and running is:
- Checkout and install all the dependencies
git clone https://github.com/DECODEproject/zenroom-studio.git
cd zenroom-studio
yarn- Run Zenroom Studio
yarn startAs 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.
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.
yarn package-mac
yarn package-linux
yarn package-win
yarn package-all
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.
-
Run the linter
yarn lint -
Automagically fix lint suggestions
yarn lint-fix
-
Run the linter
yarn lint-styles -
Automagically fix lint suggestions
yarn lint-styles-fix
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.
error eslint@5.1.0: 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.
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).
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/>.