Skip to content
This repository has been archived by the owner on Apr 5, 2024. It is now read-only.

Algorand provider is an interface that bridges the gap between dApps and wallets, allowing dApps to connect, and interact, with wallets in a standardized way.

License

Notifications You must be signed in to change notification settings

agoralabs-sh/algorand-provider

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Circular Algorand icon

Algorand Provider

Build, lint and test Build documentation npm

Algorand provider is an interface that bridges the gap between dApps and wallets, allowing dApps to connect, and interact, with wallets in a standardized way.

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

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.

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 ^

About

Algorand provider is an interface that bridges the gap between dApps and wallets, allowing dApps to connect, and interact, with wallets in a standardized way.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published