Installing Green Gekko in November 2021 (on linux)

So it's late 2021 and you wanted to test out the most popular open source trading bot. But during the first steps, you realize that packages are out of date, install scripts do not work and you are dissappointed by open source trading bots already.

Fear not. You shall succeed. :)

OK let's cut to the chase. The following steps are an update on top of the official installation steps, which probably didn't work for you. I have removed a missing dependency (ccxt package) and all the files that are dependent on it, which are some exchanges you should not really care about.

1. I assume you have already cloned ktsangop/GreenGekko on your system.
2. Go to /GreenGekko directory and remove all previously installed packages by running : rm -rf node_modules
3. Remove the /exchange/node_modules directory also by running rm -rf exchange/node_modules
4. Install nvm if you haven't already by following the instructions here: https://github.com/nvm-sh/nvm#install--update-script
5. Logout/close your shell/terminal and re-open for nvm to work
6. Install nodejs 10.18.1 by running nvm install 10.18.1
7. Use the above version by running nvm use 10.18.1
8. Install the main project by running npm install
9. Go to the /exchange directory to install the respective library by running cd exchange
10. Install the exchange libray by running npm install
11. At this step you should have no installation errors, but more than a few warnings. Ignore them if you want your sanity
12. Go back to the root project directory by running cd ..
13. Start gekko UI interface by using the default config by running npm start
14. If you are on a OS with a GUI, you should already have a browser opened on http://localhost:3000. If not, open a browser and go to that URL to access gekko UI

Green Gekko 2021 r297

A crypto trading bot written in Node.js. The purpose is to provide automated trade execution on crypto exchanges by applying algorithmic trading strategies on historical and current market data - to automate buy and sell decisions. GreenGekko is a framework to write own trading strategies, handles exchange connectivity and candle calculations, and offers features for strategy backtesting, paper trading and live trading.

GreenGekko has the focus on spot markets, while RedGekko supports trading on Futures.

Test your own trading strategies and view backtests in the browser

Operate with a Telegram bot	Gekko with Telegram in admin mode

See screenshots folder

Beta: Gekko Cloud integration

• Allows the connection of Gekko bot instances all over the world in realtime
• Connect to remote candles, orderbooks and trading advices from several Gekko bots and exchange markets. Use this information in own trading strategies by listening to onRemoteAdvice, onRemoteCandle and onRemoteOrderbook strategy events.
• Gekko Cloud has a fair-use principle, share your trading signals (but keep your strategy private) and get access to foreign strategy signals and candles. Give and take.
• Write new trading strategies by combining remote advices/candles with local strategy coding. See sample config and strategy to get started. Run: node gekko.js --config config-cloudstrategy.js
• Execute your strategy signals multiple times for friends or family crypto accounts
• Uses fast TCP socket connections, extended XMPP protocol standards
• No db setup is needed when using Gekko Cloud market. Added config.adapter = 'nodb' config option.

Green Gekko Features

• Added SHORT TRADING backtesting feature: Simply add shortTrading: true to the config.performanceAnalyzer config file section and start backtesting (cli)
• Access to orderbook snapshots for higher frequency trading strategies
  • enable orderbook fetching in config file, config.watch / fetchOrderbook: true, you may adjust tickrate: 4. Access onOrderbook event in strategies
  • calculate orderbook metrics with /core/orderbookUtil.js helper lib.
• Extended trading-strategy possibilities:
  • Heikin-Ashi candles core support, e.g. use candle.ha.close instead of candle.close inside your strategy
  • set trading amount while giving advice (e.g. buy with 50% of my portfolio)
  • allow market making or market taking order execution options
  • speedup in the internal event pipeline. Force undelayed advice execution by setting config.tradingAdvisor.fastAdviceEmit: true
  • receive "onCandle" events to allow developers building multi-timeframe strategies.
  • receive "onAdvice" events for plugin-to-plugin communication, e.g. notify the strategy with telegram initiated advices, or create containers with multiple strategies.
• Core enhancements to write async trading strategies with new async tulip and talib wrappers. The new Green Gekko core is able to wait for async strategies without running into race conditions and allows developers to write multi-timeframe and multi-market strategies.
• Rewritten telegram bot
  • User mode
    • list trading pair, strategy and candle size
    • get current price from exchange
    • get trading trend
    • subscribe/unsubscribe to trading advices
  • Admin mode
    • Password restricted access
    • Manually buy and sell tokens
      • with a sticky order
      • with a market taking order
      • set stop-loss and take-profit settings
    • Dynamically view and change strategy settings
    • Show exchange portfolio value
• Advanced Postgresql DB features (used as default db to prevent sqlite lockings)
  • Rewritten postgres plugin, using connection pooling and transaction safe candle writing (Postgres 9.5+ required)
• New command line options:
  • Checks plugin dependencies and automatically enable a plugin when it is mandatory inside a certain mode, e.g. enable the Paper Trader when in backtest mode. See new mandatoryOn property in plugins.js file.
  • New --set command line option to override config settings, e.g. --set debug=true to enable the debug mode output - no need to touch the config.js for a quick debug run
• Additional exchanges (ccxt), supporting market watch, history import, backtesting and live trading
  • HitBtc exchange support
  • HuobiPro exchange support
  • OKEX exchange support
• Coinmarketcap importer
  • Several exchanges, like HuobiPro and OKEX do not offer a large timeframe of history data. The universal Coinmarketcap importer allows fast imports for nearly every market to enable backtesting (based on 5 min. candles)
• Extended log output
  • mailer.js informs with buy and sell events by mail (different to go short/long advices)
  • More info during paper trader backtesting
• Added often used package dependencies by default to get started quickly (npm install)

Backtest examples

• T5mainasync strategy, ETHEUR, 20180101-20181001 / settings / source
• T5multimarket_strategy, ETHEUR, 20180101-20181001 / source
• T5multimix strategy, ETHEUR, 20180101-20181231
• T5multimix strategy with T5optimizer, ETHEUR, 20180101-20190901

Getting started

• git clone https://github.com/mark-sch/gekko
• cd gekko
• npm install
• cd exchange
• npm install
• cd ..
• node gekko --config sample-eth.js --import --set debug=true
• node gekko --config sample-eth.js --backtest --set debug=true
• node gekko --config sample-eth.js

While running the strategy with sample-eth.js config you should see an output like this

from time to time the exchange markets should be updated with a utility - to get new coin pairs:

• cd exchange/util/genMarketFiles/
• node update-kraken.js
• node update-binance.js

(postgresql experience required to previously setup postgres. Sample config assumes an existing db user gekkodbuser, pass 1234, with added role permission to createdb. PostgreSQL 9.5+ required.)

See further info how to get started and how to setup postgresql from crypto49er at youtube

A good practice to run Gekko processes on a server is using process manager 2 tool:

pm2 start gekko.js -i 1 --name "gekko-bnb" -- --config config-bnb.js

A more detailed guide for Ubuntu Linux can be found here and in the install documentation

Documentation

See the documentation website.