1.1.0 • Published 1 year ago
@agoralabs-sh/algorand-provider v1.1.0
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.
🛠 3. Development
3.1. Requirements
- Install Yarn v1.22.5+
3.2. Setup
- Install the dependencies:
$ yarn install
3.3. Build
- To build simply run:
$ yarn build
This will compile the Typescript source code into a dist/
directory.
📑 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.
4.2. Useful Commands
Commnad | Description |
---|---|
yarn build | Builds the source code into the dist/ directory. |
yarn run docs:build | Builds the documentation into the .docs/ directory. |
yarn run docs:serve | Serves the built documentation from the .docs/ directory. |
yarn run docs:start | Builds and runs the documentation in a development environment with hot reloading. |
yarn run lint | Runs the linter on .js and .ts files. |
yarn run prettier | Runs the prettier on .js and .ts files. |
yarn test | Runs the tests. |
👏 5. How To Contribute
Please read the Contributing Guide to learn about the development process.
📄 6. License
Please refer to the LICENSE file.
🎉 7. Credits
...TBC