Aura Explorer API

Aura Explorer API is a API Service for Aura Network explorer. Aura Explorer API also consume Horoscope for view the status of a blockchain transaction and analytics smart contract, then provides API for AuraScan query data.

Getting start

1. Clone the repository git clone https://github.com/aura-nw/aura-explorer-api

2. Navigate to the project folder cd aura-explorer-api

3. Install dependencies npm instal

Install requirements

1. INFLUXDB

   Deploy on Kubernetes with Docker file:

   • Create a StatefulSet file: influxdb.yaml with the template below:

       apiVersion: apps/v1
       kind: StatefulSet
       metadata:
       name: influx-db
       namespace: aura
       spec:
       replicas: 1
       revisionHistoryLimit: 10
       selector:
           matchLabels:
           app: influx-db
           tier: aura
       serviceName: influx-db
       template:
           metadata:
           labels:
               app: influx-db
               tier: aura
           spec:
           containers:
               - env:
                   - name: DOCKER_INFLUXDB_INIT_MODE
                   value: setup
                   - name: DOCKER_INFLUXDB_INIT_USERNAME
                   value: aura
                   - name: DOCKER_INFLUXDB_INIT_PASSWORD
                   value: aurapassword
                   - name: DOCKER_INFLUXDB_INIT_ORG
                   value: aura-dev
                   - name: DOCKER_INFLUXDB_INIT_BUCKET
                   value: aurascan
               image: influxdb:2.1.1
               imagePullPolicy: Always
               name: influx-db
               ports:
                   - containerPort: 8086
                   protocol: TCP
               volumeMounts:
                   - mountPath: /var/lib/influxdb2
                   name: influx-db-pvc
           dnsPolicy: ClusterFirst
           restartPolicy: Always
       updateStrategy:
           rollingUpdate:
           partition: 0
           type: RollingUpdate
       volumeClaimTemplates:
           - apiVersion: v1
           kind: PersistentVolumeClaim
           metadata:
               name: influx-db-pvc
           spec:
               accessModes:
               - ReadWriteOnce
               resources:
               requests:
                   storage: 25Gi
               storageClassName: gp2
               volumeMode: Filesystem
   
       ---
       apiVersion: v1
       kind: Service
       metadata:
       name: influx-db
       namespace: aura
       spec:
       ports:
           - name: influx-db-port
           port: 8086
           protocol: TCP
           targetPort: 8086
       selector:
           app: influx-db
           tier: aura
       type: NodePort
   
   

   • Run the command to create influx pod & service:

       kubectl apply -f influxdb.yaml
   

   Or install with other methods on: https://docs.influxdata.com/influxdb/v2.1/install/

2. MySQL

   Download: https://dev.mysql.com/downloads/mysql/

3. Aura node

   Check the environment here: https://docs.aura.network/environment

4. NodeJS

   Download: https://nodejs.org/en/download/

5. Redis

   Download: https://redis.io/download/

Configuration

Create a .env from .env.example:

    cp .env.example .env

NPM scripts

1. npm run build: Creates a build directory.
2. npm run start: Start production mode.
3. npm run lint: Run ESLint.
4. npm run test: Run tests & generate coverage report.
5. npm run migration:generate: Create generate migration file.

How to run

1. Native way

   Run the command: npm run start

2. Docker way

   Use Dockerfile

License

This project is licensed under the MIT License - see the LICENSE file for details.