sonr

module
v0.2.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 22, 2023 License: GPL-3.0

README

Banner

Go Reference Go Report Card License

Build privacy-preserving, user-centric applications, on a robust, rapid-scaling platform designed for interoperability, and total digital autonomy.


Getting Started

Prerequisites

  • Cosmos SDK: v0.46.7
  • Ignite CLI: v0.25.2
  • Golang: 1.18.10 darwin/arm64

Getting Started

ignite chain serve

serve command installs dependencies, builds, initializes, and starts your blockchain in development.

Configure

Your blockchain in development can be configured with config.yml. To learn more, see the Ignite CLI docs.

Web Frontend

Ignite CLI has scaffolded a Vue.js-based web app in the client/vue directory. Run the following commands to install dependencies and start the app:

cd client/vue
npm install
npm run serve

The frontend app is built using the @starport/vue and @starport/vuex packages. For details, see the monorepo for Ignite front-end development.

Release

To release a new version of your blockchain, create and push a new tag with v prefix. A new draft release with the configured targets will be created.

git tag v0.1
git push origin v0.1

After a draft release is created, make your final changes from the release page and publish it.

Install

To install the latest version of your blockchain node's binary, execute the following command on your machine:

curl https://get.ignite.com/sonr-hq/sonr! | sudo bash

Learn more about the install process.

Documentation

Sonr utilizes Mintlify to generate documentation from the source code. To run the documentation server, execute the following command:

1. Install Mintlify

npm i -g mintlify

2. Run the documentation server

cd docs
mintlify dev

Diagrams

Repository structure

Repository structure

Architecture

Architecture

For more information, see the Mintlify documentation.

Learn more

Directories

Path Synopsis
app
cmd
sonrd command
pkg
common/crypto
It converts a `WebauthnCredential` to a `webauthn.Credential`
It converts a `WebauthnCredential` to a `webauthn.Credential`
nullify
Package nullify provides methods to init nil values structs for test assertion.
Package nullify provides methods to init nil values structs for test assertion.
x
identity/types
Utility functions for DID Assertion Method - https://w3c.github.io/did-core/#assertion I.e.
Utility functions for DID Assertion Method - https://w3c.github.io/did-core/#assertion I.e.
identity/types/vault/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL