Skip to content

Latest commit

 

History

History
38 lines (33 loc) · 1.61 KB

README.md

File metadata and controls

38 lines (33 loc) · 1.61 KB
Raw

stateborn-client

stateborn-client is a web client for stateborn.org. It interact with stateborn-backend, IPFS and blockchain (through wallet extension) allowing users to operate daos, proposals and votes.

Architecutre

stateborn architecture

  • stateborn-sequencer is a backend service (REST API)
  • IPFS - read-only use for reading (validating) daos, proposals and votes
  • 'IndexedDB' - used for caching validated backend data. If removed will be rebuilt for daos and proposals but votes saved before sending to backend will be lost (lower validation level).
  • local storage - used for saving user settings
  • wallet extension - used for interacting with blockchain and reading tokens, user balance, etc. Also used for client-side signatures.

Development

Below configuration is located in quasar.conf.js file.

  1. Client starts at port 8080
  2. Default DEV server address: http://localhost:8000
  3. Default IPFS API url (DEFAULT_IPFS_GATEWAY): http://localhost:8080/api/v0

Default local blockchain network settings:

  • DEVELOPMENT_NETWORK_CHAIN_ID: '31337'
  • DEVELOPMENT_NETWORK_CHAIN_ID_HEX: '0x7A69'
  • DEVELOPMENT_NETWORK_NAME: 'Hardhat localhost'
  • DEVELOPMENT_NETWORK_ICON_NAME: '/hardhat.png'

Local blockchain network settings must match stateborn-sequencer settings.

Installation & start

  1. nvm use 18.10.0
  2. npm install
  3. npm run dev

Production

Set IPFS gateway address for production DEFAULT_IPFS_GATEWAY. Default: https://stateborn.org/api/v0

Build

  1. nvm use 18.10.0
  2. npm run build

Build is generated in dist folder.