Options
All
  • Public
  • Public/Protected
  • All
Menu

Transmute Framework

TypeScript dApp Framework

$ npm install transmute-framework@latest --save
$ yarn add transmute-framework@latest

NPM version Build Status Coverage Status Standard Version

Usage

yarn install           - install the package and its dependencies
yarn cleanup           - clean the project of all build and debug data
yarn testrpc:start     - start testrpc
yarn testrpc:stop      - stop testrpc
yarn truffle:migrate   - migrate truffle contracts
yarn truffle:test      - run truffle tests
yarn test              - test framework with jest (not truffle tests)
yarn build             - build the library
yarn docs              - build the docs
yarn docs:deploy       - deploy the docs
npm version patch      - increment the package version and create a tag
npm publish            - deploy the package to npm
pm2 kill               - kill testrpc and any other pm2 processes

Contributing

Please fork and submit PRs. There are integration tests for truffle and javascript libraries that run in travis. If these fail, expect your PR to be rejected ; )

References

Index

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc