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

Tayane Fernandes edited this page May 16, 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.

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 tools
    • you can skip the generation of a new GPG key pair (but consider doing it, if you don't have one)
  • 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. If you ever need to activate the virtual environment manually, you can use source ~/.venvs/pixua/bin/activate

    $ make install
    
  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:

  • Virtualenv

  • node

  • npm

  • Compass

    $ sudo gem update --system
    $ sudo gem install -n /usr/local/bin compass
    
  • openssl

    • sudo apt install openssl
  • 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. If you ever need to activate the virtual environment manually, you can use source ~/.venvs/pixua/bin/activate

    $ make install
    
  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