CONTRIBUTING

We will explain how to set up your environment to start working with the UI.

This will require: radare2, node and npm.

Fork

Fork the official repository and clone it on your computer:

$ git clone https://github.com/<YOU>/radare2-webui.git

Build

UI can be built in development mode or to be released (minified output). This part explain the development building process.

You can build all UI all at once:

$ make build

It will retrieve all the required dependencies using npm, gulp and bower and placing the right files into the dev directory (UI other than m will directly use the dist folder since they doesn't use a separated dev process at this time) that will be used when we will run them.

You can also build them separatly:

$ make enyo
$ make material
$ make panel
$ make tiles

If you encounter some problem with a call method 'join' of undefined building the material UI, try to update node:

sudo npm cache clean -f
sudo npm install -g n
sudo n stable

Run

Once built, you can see them working through this commands.

$ make runenyo # enyo (mobile)
$ make runm # material (responsive)
$ make runp # panels (desktop)
$ make runt # tiles (legacy)

Work

You are ready to make your modifications inside the www directory. You will find more instructions on the dedicated CONTRIBUTING file for each UI:

• material

Contribute

Commit your changes and send a pull request!