add dev setup guide to README.md

This commit is contained in:
Sayantan Karmakar 2022-04-05 22:38:06 +05:30 committed by GitHub
parent d5098e0dee
commit 40279d883b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 0 deletions

View File

@ -1,3 +1,31 @@
# Serum DevTools 🛠️
A developer tooling suite for building on Serum.
## Dev Setup
1. Get a local validator running
```
solana-test-validator -r
```
2. Init `serum-dev-tools` CLI in the `/cli` directory
```
cd cli && cargo run -- init
```
3. Deploy `serum-dex` on localnet using the CLI
```
cd cli && cargo run -- deploy l
```
4. Install node packages and update `dexAddress` in `/ts/tests/dev.spec.ts` to the deployed program ID.
```
cd ts && yarn install
```
5. Run tests
```
cd ts && yarn test
```