SChare - an implementation of the blockchain service as a service (uBSaaS) framework streamlining the complex integration of multiple blockchain services.

This application provides a platform for:

• Blockchain service developers to register and expose their service for others to use.
• Blockchain application developers to easily consume desired services to facilitate their development.
• Researchers to integrate, test and analyse novel blockchain applications with ease.

Blockchain services should be containerized or deployed before registered on the platform. The current version is mainly for researching and testing purpose. Therefore, security and scalability are not fully considered. Please do not publish any sensitive information on the platform.

Deployed SChare application can be accessed at: https://baas-db.fly.dev

Contents

• Manual Deployment

Project Dependencies

• MongoDB (Install MongoDB)
• Firebase Cloud Messaging (FCM Details)
• Redis (Redis QuickStart)

Manual Deployment

Dependencies credentials

• MongoDB: You need to create a database and a user with read/write access to the database. The connection string should be in the format of mongodb://<username>:<password>@<host>:<port>/<database>. For example, mongodb://admin:admin@localhost:27017/schare.
• Firebase: You need to create a Firebase project and generate a service account key. The service account key should be in the format of {"type": "service_account", "project_id": "your-project-id", ...}. You can download the service account key from the Firebase console.
• Redis: You need to install Redis and start the Redis server. The default connection string is redis://localhost:6379. You can change the connection string in the .env file.

Setup Node.js

Inorder to setup NodeJS you need to fellow the current steps:

Mac OS X

• Step1: Install Home brew

$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

$ brew -v

• Step2: Install Node using Brew

$ brew install node

$ node -v

$ npm -v

Linux Systems

• Step1: Install Node using apt-get

$ sudo apt-get install curl python-software-properties

$ curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -

$ sudo apt-get install nodejs

$ node -v

$ npm -v

Setup and run test application

• Step1: Git clone the application

• Step2: Install node modules

$ npm i

or

$ npm install

$ npm i -g @babel/core @babel/node @babel/cli

• Step3: Copy .env.example to .env

$ cp .env.example .env

• Step4a: Start the application

$ npm start

• Step4b: Start With Nodemon

$ npm run startWithNodemon

Build

$ npm run build

Starting the build

$ npm run deployment

The current version of your application would be running on http://localhost:8000 or http://IP_OF_SERVER:8000 (in case you are running on the server)

Build Docker Image

• Step1: Build Docker image

$ docker build -t schare .

• Step2: Run Docker image

$ docker run -d -p 8000:8000 --name schare schare

• Step3: Stop Docker image

$ docker stop schare

License

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