Skip to content

docs: add local setup tips to SDK Core reference #1097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Alex000115 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add local setup tips to SDK Core reference #1097

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/sdk/core/reference/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,16 @@ This reference documentation covers:
- Network-specific configurations and constants

## Getting Started
## Local Setup Tips

- Recommended Node.js version: **v18+** (LTS)
- Package manager: **pnpm** for faster installs and better monorepo workspace filtering

### Example

```bash
pnpm install
pnpm --filter @uniswap/sdk-core build

```typescript
import { Token, CurrencyAmount, TradeType } from '@uniswap/sdk-core'
Expand All @@ -42,4 +52,4 @@ const USDC = new Token(1, '0xA0b86a33E6417c29C8F6e3b6E4E12A82aA4Ca8e9', 6, 'USDC
const amount = CurrencyAmount.fromRawAmount(USDC, '1000000') // 1 USDC
```

For practical integration examples, see the [SDK v3 Guides](../../v3/guides/01-background.md) and [SDK v4 Guides](../../v4/overview.md).
For practical integration examples, see the [SDK v3 Guides](../../v3/guides/01-background.md) and [SDK v4 Guides](../../v4/overview.md).