swap-ui/README.md

35 lines
741 B
Markdown
Raw Normal View History

2021-05-16 17:53:57 -07:00
# `@project-serum/swap-ui`
2021-05-12 10:57:22 -07:00
2021-05-16 17:53:57 -07:00
[![Build Status](https://travis-ci.com/project-serum/swap-ui.svg?branch=master)](https://travis-ci.com/project-serum/swap-ui)
[![npm](https://img.shields.io/npm/v/@project-serum/swap-ui.svg)](https://www.npmjs.com/package/@project-serum/swap-ui)
A reusable React component for swapping on the Serum DEX. The Solana program can be
found [here](https://github.com/project-serum/swap).
2021-05-16 17:53:57 -07:00
## Developing
#### Install dependencies
```
yarn
```
#### Build
2021-05-16 17:53:57 -07:00
```
yarn build
2021-05-16 17:53:57 -07:00
```
## Run the example app
2021-05-16 17:53:57 -07:00
For local development and educational purposes, a minimal React app is provided
in the `example/` subdirectory.
2021-05-16 17:53:57 -07:00
To run, change directories via `cd example/` and start the app.
### Start the app
2021-05-16 17:53:57 -07:00
```
yarn start
2021-05-16 17:53:57 -07:00
```