Skip to content
This repository was archived by the owner on Feb 1, 2024. It is now read-only.

Commit c58982c

Browse files
committed
update instructions in README on how to compile Kelp from source
1 parent 59cabd6 commit c58982c

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,15 +93,17 @@ To compile Kelp from source:
9393
1. [Download][golang-download] and [setup][golang-setup] Golang.
9494
2. [Install Glide][glide-install] for dependency management
9595
* `curl https://glide.sh/get | sh`
96-
3. Clone the repo into `$GOPATH/src/github.com/stellar/kelp`:
96+
3. Install [Yarn][yarn-install] and [NodeJs][nodejs-install] to build the Kelp GUI
97+
4. Clone the repo into `$GOPATH/src/github.com/stellar/kelp`:
9798
* `git clone git@github.com:stellar/kelp.git`
98-
4. Change to the kelp directory and install the dependencies:
99+
5. Change to the kelp directory and install the dependencies:
99100
* `glide install`
100-
5. Build the binaries using the provided build script (the _go install_ command will produce a faulty binary):
101+
6. Build the binaries using the provided build script (the _go install_ command will produce a faulty binary):
101102
* `./scripts/build.sh`
102-
6. Confirm one new binary file:
103+
7. Confirm one new binary file:
103104
* `./bin/kelp`
104-
7. Set up CCXT to use an expanded set of priceFeeds and orderbooks (see the [Using CCXT](#using-ccxt) section for details)
105+
8. Set up CCXT to use an expanded set of priceFeeds and orderbooks (see the [Using CCXT](#using-ccxt) section for details)
106+
* `sudo docker run -p 3000:3000 -d franzsee/ccxt-rest:v0.0.4`
105107

106108
## Running Kelp
107109

@@ -306,6 +308,8 @@ See the [Code of Conduct](CODE_OF_CONDUCT.md).
306308
[golang-download]: https://golang.org/dl/
307309
[golang-setup]: https://golang.org/doc/install#install
308310
[glide-install]: https://github.com/Masterminds/glide#install
311+
[yarn-install]: https://yarnpkg.com/lang/en/docs/install/
312+
[nodejs-install]: https://nodejs.org/en/download/
309313
[spread]: https://en.wikipedia.org/wiki/Bid%E2%80%93ask_spread
310314
[hedge]: https://en.wikipedia.org/wiki/Hedge_(finance)
311315
[cmc]: https://coinmarketcap.com/

0 commit comments

Comments
 (0)