Skip to content

apatrade/apatrader

 
 

Repository files navigation

#Webtrader Build Status

This repository contains HTML, Javascript, CSS, and images for WebTrader website.

##Project goal The goal of this project is to create a full-screen trading interface for Binary.com according to the following design: Webtrader

##How to work with this project ####Linux Users $ sudo apt-get install git $ git clone https://github.com/binary-com/webtrader.git $ cd webtrader $ sudo apt-get install node npm nodejs-legacy yarn $ yarn

####Windows Users * Download and install Git from the official website. Git Bash is included. * Download and install NodeJS from the official website. NPM is included. * Download and install yarn from the official website. * Open Git Bash and run the following commands: $ git clone https://github.com/binary-com/webtrader.git $ cd webtrader $ yarn

At this point, your project is properly setup.

Run grunt to compile the project

    $ yarn build-all

You can now run following command to start a local server

    $ yarn start

Running this command will launch local server at http://localhost:9001

Since backend needs an https web address for oauth app register if you intend to debug oauth login on localhost, you need to modify your /etc/hosts file. For example the https://webtrader.local/ token in src/oauth/app_id.josn is registered to https://webtrader.local/ address, you need to do the following in order to use it locally.

Add this line to your /etc/hosts file.

    127.0.0.1 webtrader.local

Use this command to run your local server on https.

    $ sudo node_modules/.bin/grunt connect:https

Use this command to watch the files.

    $ node_modules/.bin/grunt && node_modules/.bin/grunt watch:https

Go to https://webtrader.local:35729 and accept the self signed ssl certificate for grunt livereload.

Now you can debug your app on https://webtrader.local/ locally.

In order to get SLOC(Source line of Code, which displays total number of lines of source code) report, run

    $ yarn sloc

To bump release version, run

    $ yarn major-rel
    or
    $ yarn minor-rel
    or
    $ yarn patch-rel

Every check-in or merge into master will trigger travis-ci build and do a release to production.

Every check-in or merge of PR into development will trigger travis-ci build and do a beta release

####Translation-related command

Translation related files are in /translations folder.

To extract text for translation:

    $ cd ./translations
    $ python extract.py # This will extract text from `../src/**/*.html` files.
    $ extract.py # runs `extract.js` which extracts string literals form `../src/**/*.js` files.
    $ extract.py # for merging `.po` files uses `msgmerge` command line tool.

The tool should be available on linux, if you are on Osx try brew install gettext && brew link gettext --force. to submit text to translators: push to translation branch, weblate hook will be triggered.

####Including Webtrader charts in your application You can generate the embedding code from any webtrader chart. There are several parameters that could be passed to webtrader to control the charts. Some of these parameters are

* affiliates - true/false
* instrument - e.g, frxUSDJPY
* timePeriod - 1t, 1m, 2m, 3m, 5m, 10, 15m, 30m, 1h, 2h, 4h, 8h, 1d
* lang
* hideOverlay - true/false
* hideShare - true/false
* hideFooter - true/false
* timezone

###Contribution In order to contribute, please fork and submit pull request by following all the above mentioned coding rules. While submitting your PR, make sure that you deploy your code to your forked gh-pages by running following command, so that the reviewer can have a look at the deployed code:

    $ grunt deploy-branch
    For releasing compressed code

About

Full-screen web trading app

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 82.1%
  • HTML 11.9%
  • CSS 5.6%
  • Python 0.4%