# DODO Widget

<p align="center">
  <a>
    <img src="https://i.postimg.cc/W4q937Db/Logo.png" alt="DODO" />
  </a>
</p>

<p align="center">
<a href="https://www.npmjs.com/package/@dodoex/widgets"><img src="https://img.shields.io/npm/v/@dodoex/widgets" alt="npm version" /></a>
<p>

## DODO Swap Widget

The DODO Swap Widget allows you to build customized front-end interfaces for the DODO protocol, and embed widgets in DeFi applications for quick asset exchange and other uses. DODO currently supports 12 chains in total, including Ethereum, BNB Chain, Polygon, Arbitrum, Avalanche, Heco, Moonriver, OKC, BOBA, Optimism, Aurora, and Cronos. We intend to add support for more chains in the future.

## Installation

Install the widgets library via `npm` or `yarn`.

```js
yarn add @dodoex/widgets
```
```js
npm i --save @dodoex/widgets
```

## Documentation
You can find the DODO Widget documentation [on the website](https://docs.dodoex.io/english/developers/swap-widget) and check out the [Getting Started](https://docs.dodoex.io/english/developers/swap-widget/getting-started) page for a quick overview.
- [Profit-Sharing Instructions](https://docs.dodoex.io/english/developers/swap-widget/profit-sharing-instructions)
- [API](https://docs.dodoex.io/english/developers/swap-widget/api)

## Examples
Inside the `examples` folder, there two different examples,

For react app:

```shell
$ git clone git@github.com:DODOEX/widgets.git
$ cd example/react-app
```

For js app:
```shell
$ git clone git@github.com:DODOEX/widgets.git
$ cd example/js-app
```

Install and run the example:

```bash
yarn          # install dependencies
yarn start    # run the development server
# or
npm           # install dependencies
npm run start # run the development server
```

Other details:
- [React App](https://github.com/DODOEX/widgets/tree/main/example/react-app)
- [JS App](https://github.com/DODOEX/widgets/tree/main/example/js-app)

## License

- [GPL-3.0 ](https://github.com/DODOEX/widgets/blob/main/LICENSE)

## About DODO

- [DODO Web](https://dodoex.io/)
