sugarfunge-local

Software requirements

• Install Docker

• Install Docker-Compose

Usage

• Clone the project

git clone https://github.com/SugarFunge/sugarfunge-local.git

• Copy the environment file as .env

cp .env.example .env

• Login with Docker or build the SugarFunge docker images and configure the docker-compose file with those images

docker login -u (username) -p (password) sugarfunge.azurecr.io

• Run with docker-compose

docker-compose up -d

• The following services will be available after docker-compose is running

1. Sugarfunge Node: Local blockchain node (Accessible at ws://localhost:9944)
2. Sugarfunge API: Blockchain API (API available at http://localhost:4000)
3. Sugarfunge Status: Minimal blockchain information (Click here to access)
4. Sugarfunge Explorer: polkadot-js blockchain explorer (Click here to access)
5. PostgreSQL: Powerful, open source object-relational database system (Accessible at http://localhost:5432) (Tip: Change the port number or remove the port section in the docker-compose file if you already have a postgres instance running to avoid port conflicts)
6. Keycloak: Open source identity and access management solution (Click here to access) (Tip: The username and password is keycloak)
7. IPFS: Distributed storage (Click here to access the WebUI) (API available at http://localhost:8001)
8. Prometheus: Power your metrics and alerting (Click here to access)
9. Grafana: Operational dashboards for your data here, there, or anywhere (Click here to access) (Tip: The username and password is admin)

• If you want update or stop the images

# Update SugarFunge images (requires to be logged with Docker)
$ docker-compose pull
# Stop the images
$ docker-compose down
# Stop the images and delete the PostgreSQL data
$ docker-compose down --volumes