Skip to content

README.md

Latest commit

 

History

History
67 lines (51 loc) · 2.24 KB

README.md

File metadata and controls

67 lines (51 loc) · 2.24 KB

Meter for the New World

This app is a Babbage-operated example built on the BRC-100 wallet model and the BSV TypeScript SDK. It can run with Babbage's Metanet distributions or any compatible wallet where the app's dependencies and deployment configuration support it.

If you have problems accessing hosts: broadcasterResult.description: All local topical hosts have rejected the transaction.

Try using your browser with a command switch. Ensure you use a temporary profile if you do disable your security settings.

For Linux: brave-browser --disable-web-security --user-data-dir="/tmp/brave_dev"

BSV Project

Standard BSV project structure.

Helpful Links:

Getting Started

  • Clone this repository
  • Run npm i to install dependencies
  • Run npm run lars to configure the local environment according to your needs
  • Use npm run start to spin up and start writing code
  • When you're ready to publish your project, start by running npm run cars and configuring one (or, especially for overlays, ideally multiple) hosting provider(s)
  • For each of your configurations, execute npm run build to create CARS project artifacts
  • Deploy with npm run deploy and your project will be online
  • Use cars interactively, or visit your hosting provider(s) web portals, to view logs, configure custom domains, and pay your hosting bills
  • Share your new BSV project, it is now online!

Directory Structure

The project structure is roughly as follows, although it can vary by project.

| - deployment-info.json
| - package.json
| - local-data/
| - frontend/
  | - package.json
  | - webpack.config.js
  | - src/...
  | - public/...
  | - build/...
| - backend/
  | - package.json
  | - tsconfig.json
  | - mod.ts
  | - src/
    | - contracts/...
    | - lookup-services/...
    | - topic-managers/...
    | - script-templates/...
  | - artifacts/
  | - dist/

The one constant is deployment-info.json.

License

Open BSV License