This repository contains the static HTML, Javascript, CSS, and images content of the deriv.app website.
In order to work on your own version of the Deriv.com Javascript and CSS, please fork this project.
You will also need to install the following on your development machine:
- Ruby, RubyGems
- Sass (
sudo gem install sass
) - Node.js (10.14.2 or higher is recommended) and NPM (see https://nodejs.org/en/download/package-manager/)
- Go to project root, then run
npm install
- Grunt (
sudo npm install -g grunt-cli
)
In order to use your custom domain, please put it in a file named CNAME
inside scripts
folder of your local clone of binary-static.
-
Register your application here. This will give you the ability to redirect back to your github pages after login. Use
https://YOUR_GITHUB_USERNAME.github.io/deriv-com/en/logged_inws.html
for the Redirect URL andhttps://YOUR_GITHUB_USERNAME.github.io/deriv-com/en/redirect.html
for the Verification URL.If you're using a custom domain, replace the github URLs above with your domain.
-
In
src/javascript/config.js
: Insert theApplication ID
of your registered application inuser_app_id
.
- NOTE: In order to avoid accidentally committing personal changes to this file, use
git update-index --assume-unchanged src/javascript/config.js
- Run
grunt dev
grunt dev
grunt deploy
grunt dev --path=about-us
There are times that you are working on various branches at the same time, and you want to deploy/test each branch separately on your gh-pages, you can simply use --branch=branchname
for grunt commands:
grunt dev --branch=branchname
This will deploy your changes to a sub-folder named:br_branchname
and it can be browsed at: https://YOUR_GITHUB_USERNAME.github.io/deriv-com/br_branchname/
In order to remove the created folders from your gh-pages, you can use either:
-
grunt dev --cleanup
: removes allbr_*
folders and deploys to the root folder.or
-
grunt shell:remove_folder --folder=br_branchname1,br_branchname2,...
: only removes the specified folder(s) from your gh-pages.or
-
grunt shell:remove_folder --keep --folder=br_branchname1,br_branchname2,...
: only keeps the specified folder(s) on your gh-pages and removes everything else. Just add the--keep
flag.
- To preview your changes locally, run
sudo grunt serve
- It will watch for js/css changes and rebuild on every change you make.
- To test changes made to templates, you need to re-compile them:
grunt shell:compile_dev
to re-compile all templates.grunt shell:compile_dev --path=about-us
to re-compile only template(s) which serve about-us path in URL.
- To fix eslint errors run
npm run eslint
grunt release --{release type}=1 [--cleanup] [--reset]
(The value is needed when more than one option is used)
{release type}
(mandatory)- Should be one of
staging
,production
,translations
,nex_beta
,nex_production
. - In order to prevent accidentally releasing to the wrong target, it is mandatory to provide one of these parameters.
- Your remote origin will be checked to be the correct target of the given parameter.
- Your current branch will be checked to be the correct branch of the given parameter.
- Should be one of
--cleanup
[optional]- Create CNAME file with proper value according to remote origin
- Deploy to gh-pages with the option
add: false
--reset
[optional]- Removes all commits from
gh-pages
branch before release (staging only)
- Removes all commits from