Installation
ℹ️
There're two ways to use AzuroSDK:
- The first is for those who want to take a sample dApp we created and build on top of it.
- The second is for those who don't need an example project and can make a dApp from ground up that interacts with Azuro protocol as easily as our pre-built example.
Below, you'll find guides to install AzuroSDK for each of these cases.
1. To build on top of our sample dApp
- Clone the Azuro SDK: Use Git to clone the repository from GitHub with
git clone https://github.com/Azuro-protocol/sdk.git
in your terminal. - Go to the Example Directory: Navigate into the example directory with
cd sdk/examples/nextjs
. - Install Dependencies: Run
npm install
to install all necessary dependencies for running the example. Note that the SDK itself does not require a separate installation. - Run the Development Server: Start the development server using
npm run dev
. This will get your example application up and running. - Access the Application: Open your web browser and go to
http://localhost:3000
to view the application.
2. To use SDK in your original project
- Install the SDK Package:
npm install @azuro-org/sdk
. - Install Peer Dependencies:
@apollo/client@^3.8.0-beta.7
@azuro-org/dictionaries@^3.0.12
graphql@^16.6.0
react@^18.2.0
viem@^2.17.3
wagmi@^2.10.9