1.1.0 • Published 1 year ago

@agoralabs-sh/algorand-provider v1.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Table of contents

📦 1. Installation

  • Using npm:
npm install @agoralabs-sh/algorand-provider
  • Using yarn:
yarn add @agoralabs-sh/algorand-provider

📚 2. Documentation

For full documentation, please see here.

Back to top ^

🛠 3. Development

3.1. Requirements

Back to top ^

3.2. Setup

  1. Install the dependencies:
$ yarn install

Back to top ^

3.3. Build

  • To build simply run:
$ yarn build

This will compile the Typescript source code into a dist/ directory.

Back to top ^

📑 4. Appendix

4.1. Useful Information

  • ARC-0001: the direction of the code leans heavily on what this ARC suggests and is in reality an extension of this ARC.

Back to top ^

4.2. Useful Commands

CommnadDescription
yarn buildBuilds the source code into the dist/ directory.
yarn run docs:buildBuilds the documentation into the .docs/ directory.
yarn run docs:serveServes the built documentation from the .docs/ directory.
yarn run docs:startBuilds and runs the documentation in a development environment with hot reloading.
yarn run lintRuns the linter on .js and .ts files.
yarn run prettierRuns the prettier on .js and .ts files.
yarn testRuns the tests.

Back to top ^

👏 5. How To Contribute

Please read the Contributing Guide to learn about the development process.

Back to top ^

📄 6. License

Please refer to the LICENSE file.

Back to top ^

🎉 7. Credits

...TBC

Back to top ^

1.1.0

1 year ago

1.0.0

1 year ago