Skip to content
This repository has been archived by the owner on May 2, 2023. It is now read-only.
/ assist-service Public archive

Assist Service provides unparalleled access to the Elastos ecosystem that lets developers connect to any component of Elastos via a simple REST API

License

Notifications You must be signed in to change notification settings

tuum-tech/assist-service

Repository files navigation

Assist Service

Assist Service provides unparalleled access to the Elastos ecosystem that lets developers connect to any component of Elastos via a simple REST API

To start, clone assist-service repo

git clone https://github.com/tuum-tech/assist-service.git;
cd assist-service;

Prerequisites

  • Install node(v12 or later) and npm
  • Install dependencies
    npm i
    

Run

  • Copy example environment file
    cp .env.example .env
    
  • Modify .env file with any number of wallets to use
  • [OPTIONAL]: If you want to remove previous mongodb data and start fresh, remove the mongodb directory
    ./setup.sh cleanup
    
  • Start API server
    ./setup.sh start; npm run dev
    

API Endpoints

For detailed deep-dive of all the API endpionts, you can check out Assist Service Documentation.

Healthcheck

To check whether the Assist Service is running:

curl http://localhost:2000/v1/healthCheck/ping
Request type: GET
Url: /v1/healthCheck/ping
Return:
    Success: { '_status': 'OK', 'message': 'pong' }
    Failure: { '_status': 'ERR', '_error': { 'code': 404, 'message': 'err_message' } }

Deploy to production

cp .ebextensions_prod/envvariables.config .ebextensions/envvariables.config
git commit -am "eb deploy"
eb deploy
git reset HEAD^
git checkout .ebextensions/envvariables.config

About

Assist Service provides unparalleled access to the Elastos ecosystem that lets developers connect to any component of Elastos via a simple REST API

Resources

License

Stars

Watchers

Forks

Packages

No packages published