Skip to content
This repository has been archived by the owner on Jan 2, 2020. It is now read-only.

Developer Setup on native OS

Tulio Casagrande edited this page Jun 1, 2017 · 22 revisions

Please ensure that you have an email user from your preferred LEAP provider. If you don't have access to an existing LEAP provider, you can create an account at Bitmask mail demo provider. Details for developer installations on OSX and Debian distributions are explained below.

Issues for both OSX / Linux

On OSX

First, you will need to install some system-wide dependencies:

  • Command Line Tools for MacOS
    • xcode-select --install should do it
  • Python 2
    • we recommend Homebrew and then run brew install python
  • Pip
  • Virtualenv
  • GPG versions 1.4 or 2.0
    • run gpg --version to confirm the version you have installed
    • GPG version 2.1 won't work properly
    • if the version is 2.1 or higher, execute brew install gpg1 and export the gpg binary, according to the Caveats section (it'd be something like PATH="/usr/local/opt/gnupg@1.4/libexec/gpgbin:$PATH")
    • we recommend creating a backup of your ~/.gnupg prior to first use!
  • npm
    • brew install npm
  • Compass
    sudo gem update --system
    sudo gem install -n /usr/local/bin compass
    
  • openssl
    • brew install openssl

Installation steps

  1. Add to your ~/.bashrc:

    # needed by the pixelated-user-agent
    export LDFLAGS="-L/usr/local/opt/openssl/lib"
    export CPPFLAGS="-I/usr/local/opt/openssl/include"
  2. Clone the repository

    git clone https://github.com/pixelated/pixelated-user-agent.git
    cd pixelated-user-agent
    
  3. This step will create a virtual environment and install the Pixelated User Agent

    make install
    

    If you ever need to activate the virtual environment manually, you can use source ~/.venvs/pixua/bin/activate

  4. This step will run the Pixelated User Agent against the Bitmask mail demo provider (or you can use your favorite LEAP provider)

    make run provider=mail.bitmask.net
    

On Debian distributions

First, you will need to install some system-wide dependencies:

  • Python 2, pip and virtualenv

    sudo apt install python-dev python-pip python-virtualenv
    
  • node

    Please follow the instructions on the website. For Debian jessie you need to do this:

    curl -s https://deb.nodesource.com/gpgkey/nodesource.gpg.key | sudo apt-key add -
    sudo sh -c "echo deb https://deb.nodesource.com/node_7.x jessie main > /etc/apt/sources.list.d/nodejs.list"
    sudo apt update
    sudo apt install nodejs
    
  • Compass

    sudo apt install ruby-compass
    
  • openssl

    sudo apt install openssl libssl-dev
    
  • libffi

    sudo apt install libffi6 libffi-dev
    

Installation steps

  1. Clone the repository

    git clone https://github.com/pixelated/pixelated-user-agent.git
    cd pixelated-user-agent
    
  2. This step will create a virtual environment and install the Pixelated User Agent

    make install
    

    If you need to activate the virtual environment manually, you can use source ~/.venvs/pixua/bin/activate

  3. This step will run the Pixelated User Agent against the Bitmask mail demo provider (or you can use your favorite LEAP provider)

    make run provider=mail.bitmask.net