Visual automation for binary
Binary Bot uses Google Blockly to provide a puzzle like automation environment to trade using binary.com API version 3.
Ensure that your environment contains the following packages.
- node
- npm
- git (for contribution)
In order to work with Binary-Bot application, you must create your own version of this project. Please fork the project - https://github.com/binary-com/binary-bot to your git account.
You will need to perform the following on your development machine:
-
Change the current working directory to the location where you want the cloned directory.
-
Clone the forked repo using
git clone [URL for the forked repo]
-
Run
cd binary-bot
-
Create a feature branch from master -
git checkout -b [branchName]
. -
Run
npm install
Note: - issue with installing packages
In order to run our application for the first time, you need to configure your hosts file:
If you are using a UNIX based system (Mac or Linux), Do the following:
- Open terminal.
- Open hosts file in your preferred text editor using
sudo vim /etc/hosts
. - Add a new entry pointing to
127.0.0.1 localbot.binary.sx
- Save the file
For Windows:
-
Run Microsoft Notepad as an administrator.
-
From Notepad, open the file:
c:\Windows\System32\Drivers\etc\hosts
-
Add a new entry pointing to
127.0.0.1 localbot.binary.sx
-
Save the file
If you want to use Google Drive features in the project (to Save/Load strategies)
you need to create a file called .env
at the project root with the following content:
GD_CLIENT_ID=GOOGLE_DRIVE_CLIENT_ID
GD_API_KEY=GOOGLE_DRIVE_API_KEY
GD_APP_ID=GOOGLE_DRIVE_APP_ID
Here comes useful links for more information on how to configure your project with Google Drive integration:
Make sure to set the endpoint for running the application on the localhost
-
Run
npm start
on the binarybot directory. This will open the application in your default browser.Note: - Getting Permission Denied Error
-
Now we have to set the endpoint for running the application on the localhost. For this, Go to
http://localbot.binary.sx/endpoint.html
. Make sure the Server is set toblue.binaryws.com
and O Auth App ID is16014
Click submit. -
Navigate to
http://localbot.binary.sx/bot.html
(Note that the protocol ishttp
and nothttps
)Note: - Getting error "This site can’t be reached" on localhost
-
And now you are ready with your setup.Login to the binary account using the Binary.com account credentials. Run the bot
- Make your changes to the source code
- Run test command to make sure your changes are correct
npm run test
- Push your changes to your forked repo:
git add .
git commit -m "describe your changes"
git push origin BRANCH_NAME
You can set up your GitHub Pages to deploy your repository.
-
First you need to set up custom domain. Go to
https://github.com/YOUR_GITHUB_USERNAME/binary-bot/settings/pages
and set your custom domain toYOUR_GITHUB_NAME.binary.sx
-
Run the command below in your project directory.
npm run release --branch [branchname] # can contain /
- Now, your repository can be found at
https://YOUR_CUSTOM_DOMAIN/BRANCH_NAME
gulp test-deploy # for local test deploy
npm run release --branch <branch-name> # to deploy a branch (eg., beta)
npm run release-production # to release it to production
git pull --rebase upstream master
npm install
npm i -g binary-bot
bot -h // For a quick help
bot bot-example.js
ENDPOINT='wss://ws.binaryws.com/websockets/v3?l=en&app_id=1169' bot bot-example.js
start```
Make sure to use HTTP instead of HTTPS: https://localbot.binary.sx/bot.html => http://localbot.binary.sx/bot.html