Code Monkey home page Code Monkey logo

algosearch's Introduction

AlgoSearch logo image

Website algosearch.io License

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

  1. Install Nginx, certbot, CouchDB, go-algorand, and setup SSL with Let's Encrypt.
  2. 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

  1. Enter your sitename in src/constants.js.
  2. 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.

License

License

Copyright (C) 2020, Anish Agnihotri.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.