Skip to content

Commit

Permalink
update Readme with getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
Diogomartf committed Nov 6, 2023
1 parent b6e2386 commit d894187
Showing 1 changed file with 25 additions and 6 deletions.
31 changes: 25 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

## Getting Started

### Running tests

To run the tests, follow these steps. You must have at least node v16 installed.

First clone the repository:

```sh
Expand All @@ -21,13 +17,36 @@ cd swapr-sdk
Install dependencies

```sh
npm install
yarn install
```

Generate GraphQL
```sh
yarn codegen
```

Build
```sh
yarn build
```

Connect package an app to sdk locally
```sh
yarn link
```
And on the app repo
```sh
yarn link "../swapr-sdk/" #e.g. path to sdk
```

### Running tests

To run the tests, follow these steps. You must have at least node v16 installed.

Run tests

```sh
npm run test
yarn test
```

## Eco Router Trades
Expand Down

0 comments on commit d894187

Please sign in to comment.