Skip to content

Commit

Permalink
Merge pull request #12 from cjthoma1/updated_readme
Browse files Browse the repository at this point in the history
Added getting started instructions
  • Loading branch information
cjthoma1 authored Apr 13, 2022
2 parents 27c6226 + b2a4193 commit 10e6c7d
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,28 @@ The goal of this guide is to lay out best practices regarding writing, testing a

### NodeJS and Yarn

First, install the LTS (long-term support) version of [nodejs](https://nodejs.org/en). This is `14.17.0` at the time of writing. NodeJS bundles `npm`.
First, install the LTS (long-term support) version of [nodejs](https://nodejs.org/en). This is `16.14.2` at the time of writing. NodeJS bundles `npm`.

Next, install [yarn](https://yarnpkg.com):

```zsh
npm install -g yarn
```

### Getting Started
1. Create .env file

2. Add env variable equal to your metamask private key [Steps to get key](https://metamask.zendesk.com/hc/en-us/articles/360015289632-How-to-Export-an-Account-Private-Key)
`METAMASK_PRIVATE_KEY=<private key>`

3. Intall your dependencies
```zsh
yarn
```
4. Run arbitriage bot (Check package.json for options)
```zsh
yarn run arb:pangolin:joe:wavax:usdt --network mainnet
```
### AvalancheGo and Avash

[AvalancheGo](https://github.com/ava-labs/avalanchego) is an Avalanche node implementation written in Go. [Avash](https://docs.avax.network/build/tools/avash) is a tool to quickly deploy local test networks. Together, you can deploy local test networks and run tests on them.
Expand All @@ -26,15 +40,15 @@ npm install -g yarn

It is also helpful to have a basic understanding of [Solidity](https://docs.soliditylang.org) and [Avalanche](https://docs.avax.network).

## Dependencies
<!-- ## Dependencies

Clone the [quickstart repository](https://github.com/ava-labs/avalanche-smart-contract-quickstart) and install the necessary packages via `yarn`.

```zsh
$ git clone https://github.com/ava-labs/avalanche-smart-contract-quickstart.git
$ cd avalanche-smart-contract-quickstart
$ yarn
```
``` -->

## Write Contracts

Expand Down

0 comments on commit 10e6c7d

Please sign in to comment.