README.md

Webtrader

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

In this document:

• Pre-installation
• Quick start
• How to contribute
• Manage translations
• Test link deployment

Pre-installation

Before running or contribute to this project, you need to have the setup of the following packages in your environment:

• node >=12.3.0
• npm
• git

Quick start

1. Fork the project

   In order to work on your own version, please fork the project to your own repo.

2. Clone using SSH

   git clone git@github.com:your-github-username/webtrader.git

3. Verify Remote

   git remote -v

4. Add remote using webtraders ssh key

   git remote add git@github.com:binary-com/webtrader.git

5. Enter project directory

   cd webtrader

6. Install the dependencies:

   npm install
   npm run build

7. Start Running the Application:

   npm start

8. Open the source code and start editing!

   Your site is now running at http://localhost:9001!

Note*: 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.

To bump release version, run

    $ npm major-rel
    or
    $ npm minor-rel
    or
    $ npm 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

How to contribute

In order to contribute, please fork and submit pull request by following all the following mentioned coding rules:

1. Create branch from latest master branch

   ```sh
   git checkout master
   git pull upstream master
   git checkout -b {your_branch_name}
   ```
   

2. After finish editing, Add, Commit and Push your changes to github

    ```sh
    $ git add .
    $ git commit -m {your ideal message}
    $ git push --set-upstream origin {your-branch-name}
    ```
   

3. Go to your github and create a pull request

4. Go to pull request page and copy the url link that will be your PR link.

5. Do Test link deployment

Manage translations

Translation related files are in /translations folder.

To extract text for translation:

    ```sh
    $ npm run build
    $ cd ./translations
    $ python extract.py
    $ extract.py # extracts string literals from `dist/uncompressed` (from *.html and *.js)
    $ extract.py # for merging `.po` files uses `msgmerge` command line tool.
    ```

Note*: The tool should be available on linux, if you are on Osx try brew install gettext && brew link gettext --force.

Note*: To submit text to translators: push to translation branch, weblate hook will be triggered.

Note*: To see CrowdIn In-Context translations pass querystring ?lang=ach (obs not for production env)

Test link deployment

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 at this url {your-username}.github.io/webtrader/{your-branch-name}:

    ```sh
    $ npm run deploy-gh-pages
    ```

The command above will create a new gh-pages branch and will likely deploy your page at the above url (look for correct url in your PR if the link above isn't working).

Your deployed page will likely be blank because it's missing a few files during deployment in gh-pages branch. This is solely deployment issue. Do the following to get around the issue...

Use the following link to get missing files

```sh
https://github.com/binary-com/webtrader/tree/gh-pages
```

1. Open inspect element of your deployed page

   1. Go to console tab.
   2. Look at the error to see which file is missing.
   3. Copy content of missing file from reference link above and manually add to {YOUR_BRANCH_NAME} folder in your gh-pages branch on your github repo.
   4. Ensure file name and file path match exactly as described in console error. Commit new file to your gh-pages branch.
   5. Run npm run deploy-gh-pages
   6. Refresh your deployed link and repeat the step 1 through 6 until your deployed page is no longer blank and console errors are gone.

2. Register your application here. This will give you the ability to redirect back to your deployed page after login.

   Use https://YOUR_DEPLOYED_LINK/en/logged_inws.html for the Redirect URL and https://YOUR_DEPLOYED_LINK/en/redirect.html for the Verification URL.

   • Have api key ready from deriv app account in order to register
   • Make note of your App ID to update in redmine card