Skip to content


Repository files navigation

NOTE: While open-source, some features of this block explorer are not easily compatible with running your own version locally, and this is no longer recommended (except for expert users).


Setup Instructions



  • Follow the instructions here to install Homebrew and then (re)install python.
  • If for some reason the step above does not install pip and virtualenv, follow the instructions here to get pip and then install virtualenv using pip install virtualenv.
  • Install the foreman gem for accessing environmental variables: $ gem install foreman
  • Optional (advanced features): Install the latest stable version of postgres 9. ([Postgresapp for Mac] is quite easy to install.


  • $ sudo apt-get install postgresql libpq-dev ngrok-client ngrok-server


  • $ cd into your projects/workspaces directory and run $ git clone The result of $ git remote -v should look like this:
origin (fetch)
origin (push)
  • $ cd explorer/ to get to the project root direction, create a python3 virtual environment ($ virtualenv -p python3 venv) and then activate it ($ source venv/bin/activate)
  • Install requirements: $ pip3 install -r requirements.txt (this will take a few mins)
  • Create a .env file in the project root directory with the following:

(these are for your local machine, production is a little different as is smartly designed to default to production settings)

  • Create a database on your local machine with whatever name you like. I recommend explorer_local so it's clear you're working on a local copy. You'll be using this above in DJ_DEFAULT_URL. I've assumed your user is postgres, but you could have a different user.
  • Create DB tables from code (replace foreman with heroku for running on production, which should basically never happen again):
# Create tables and run migrations:
$ foreman run python3 migrate

Run the Site Locally

Run the webserver locally:

$ foreman run python3 runserver

Now visit:

Submit Your First Pull Request

First, pull the latest version of the code from github:

$ git pull origin master

Make a new branch:

$ git checkout -b my_branch

Make some trivial change and commit it:

$ git commit -am 'my changes'

Push it up to github:

$ git push origin my_branch

You can submit your pull request here:

Congrats, you're all setup!

Post Setup Instructions

Build Awesome Features

You're on your own for that.

Git Foo

Compare your local version of site to what's on github:

$ git log origin/master..HEAD --oneline