laconic-console/README.md
Nabarun 61f445abe5
All checks were successful
Publish npm package to gitea / npm_publish (18.x) (release) Successful in 2m58s
Update steps for running with laconic2d (#48)
Part of https://www.notion.so/Create-laconic-registry-SDK-d3a636d4aba44f7cbba3bd99b7146811?pvs=23

Reviewed-on: #48
Co-authored-by: Nabarun <nabarun@deepstacksoft.com>
Co-committed-by: Nabarun <nabarun@deepstacksoft.com>
2024-03-22 06:32:06 +00:00

2.2 KiB

Console

Laconic console application.

User interface for submitting and reading records registered on Laconic.

Development

  • Clone the required repos:

    • laconic2d

      git clone git@git.vdb.to:cerc-io/laconic2d.git
      
  • Run the laconic2d chain:

    • In laconic2d repo, start the chain

      ./scripts/init.sh clean
      
  • Run the laconic-console app

    • From the root of this repo, run:

      yarn
      

      NOTE: There is a warning containing error while installing dependencies

      warning Error running install script for optional dependency: ".../laconic-console/node_modules/sodium-native: Command failed.
      Exit code: 1
      ...
      Error: ./configure exited with 127
      

      This can be ignored as it is an error for installing optional dependency

    • Start the app:

      CONFIG_FILE=config-local.yml yarn start
      
    • Open console at http://localhost:8080

    • To view records in the console, the test suite in registry-sdk can be run

      • Clone the registry-sdk repo:

        git clone git@git.vdb.to:cerc-io/registry-sdk.git
        
      • In registry-sdk repo, copy .env.example file and create a .env file

        cp .env.example .env
        
      • Export the private key using:

        laconic2d keys export alice --keyring-backend test  --unarmored-hex --unsafe
        
      • Copy the private key exported above and assign it to variable PRIVATE_KEY in the .env file.

      • Install dependencies

        yarn
        
      • Run the tests in registry-sdk repo:

        yarn test
        

        NOTE: One test from util.test.ts fails as mentioned in the PR

      • Open console at http://localhost:8080 to view the records.