• About

• Getting Started

• Development

  • App Architecture

  • APP Architecture Explained

  • Running the APP

• Deployment

  • Deployment Architecture
  • Deployment Architecture Explained
  • Docker
  • Kubernetes GKE

• Built Using

• Author

• This application allow you to track your amount of Ether and get daily notification form your account in ethereum blockchain .
• Please Notice That we using the rinkeby test blockchain Network for this application.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

You need to install the fellowing software in order to get the application up and running :

• Node.js and npm.
• Docker.
• Kubernetes on cloud.

The application architecture contain 3 part

• Node js application that connect to the blockchain network using the web3js as interface via infura
• the application watch all transaction that happened in the blockchain network ( because all transactions will be broadcast at all node in the blockchain network )
• when we detect a transaction happened FROM the provided account we execute code to get the Actual balance for that specific account ( using the web3js library ) and use the third party api for messages services (telegram, slack , etc ) to send notification.

everyday at giving time ( you can injected it on the deployment process ) we execute a code to get the actual balance for that account and send a notification ( using messages service ).

• Download and Install node.js and NPM from https://nodejs.org/en/download/ .

• Download or clone the project code from https://github.com/abdm64/DAPP-JS.git

• Install all required npm packages by running npm install from the command line in the app folder (where the package.json is located).

cd app

npm install

• Before start the application you should change keys in the app/src/config folder (account , tokens etc) in order to get messages from the the application in your slack and telegram channel.

• Start the application by running npm start from the command line in the app folder, you should see the message: "the application Now is running, start watch your notification".

npm start 

• Now the application should send you a notification at every transaction happened in your account and will send you daily check of your actual balance

• In order to deploy this application in production we need :
  • Docker to build image for this application and push it to the docker hub or private registry .
  • Kubernetes cluster to run the application in production mode from the image that was created .

• Download and install docker in your machine

• Build your own docker image and push it to your repo by running "docker build -t my-app-name:v1 . " from the command line in app folder

cd app

docker build -t my-app-name:v1 .

you need to push the image to Docker hub or your own registry .

• Run your Docker image for the application by the command line

docker run -e [inject your env variable here] my-app-name:v1

• Also you can run the application as service by running

docker-compose up 

and the docker-compose.yaml handle all the task for you

• to drop the running container use the command

docker-compose  down 

• you should have access to Kubernetes cluster GKE or you can download and install minikube in your machine

• Please fellow the instruction in the eth-app.yaml file in the k8s folder to update all information needed ( env var ) in order to the application work on Kubernetes cluster

• To run the application on Kubernetes cluster ( GKE) just run the fellowing command

kubectl apply -f k8s

• this will create 3 Kubernetes objects:

  • Deployment for the application with one pod ( running container) insuring high availability for that service.
  • Secret to store all you secret data including tokens password etc
  • Namespace a virtual cluster for all your resource related to this application ( in our case the secret and the deployment )

• to drop the application just run the command :

kubectl delete  -f k8s

• Web3.js - blockchain interface for javascript program.
• Telegraph - telegram api for javascript program.
• @slack/web-api - Web Framework for slack api .
• NodeJs - Server side environment for javascript .
• Docker - Software platform for building and packaging applications.
• Kubernetes - Container Orchestration.

• @abdm64 Backend | DevOps Engineer @ Djezzy

Made with ❤️ by Abdellah