AlgoSearch (live deployment)

AlgoSearch enables you to explore and search the Algorand blockchain for transactions, addresses, blocks, assets, statistics, and more, in real-time. It's a simple, easy-to-deploy, and open-source block explorer to be used alongside an Algorand archival node.

Dependencies

Node.js 8+ for use with server and front-end.
Nginx for reverse proxy to Node server.
Let's Encrypt or your own SSL certificate solution. Traffic on AlgoSearch must pass through HTTPS.
go-algorand for Algorand goal node (must support archival indexing).
CouchDB as database solution.

Work on AlgoSearch is funded by the Algorand Foundation through a grant to Anish Agnihotri. The scope of work includes the development of an open-source block explorer (AlgoSearch) and a WIP analytics platform.

Run locally

Linux / OSX

The go-algorand node currently aims to support only Linux and OSX environments for development.

Disclaimer

Simpler installation instructions, a hands-on guide, and a one-click deploy Docker image will be published upon final completion of AlgoSearch.

Environment setup

Install Nginx, certbot, CouchDB, go-algorand, and setup SSL with Let's Encrypt.
You can use following sample Nginx configuration:

server {
    server_name YOUR_WEBSITE_DOMAIN;

    root /var/www/html;
    index index.html index.htm index.nginx-debian.html;
    location / {
        proxy_pass http://localhost:8000;
        proxy_http_version 1.1;
    }
    location /v1 {
        proxy_pass http://localhost:8080/v1;
        proxy_http_version 1.1;
    }

    # Certbot configuration automatically here

    # Security headers
    add_header Strict-Transport-Security "max-age=31536000; includeSubDomains; preload";
    add_header X-Content-Type-Options nosniff;
    add_header X-XSS-Protection "1; mode=block";
    add_header Referrer-Policy "origin";
}

server {
    if ($host = YOUR_WEBSITE_DOMAIN) {
        return 301 https://$host$request_uri;
    }

    listen 80 default_server;
    listen [::]:80 default_server;

    server_name algosearch.io;
    return 404;
}

AlgoSearch setup

install

# Run in folder root directory
npm install

configure

Enter your sitename in src/constants.js.
Copy service/global.sample.js to service/global.js and enter your go-algorand node details.

build

# Run in folder root directory
npm run build

Documentation

The Wiki is currently under construction.

Anish-Agnihotri/algosearch