Skip to content

Latest commit

 

History

History
83 lines (60 loc) · 3.53 KB

README.md

File metadata and controls

83 lines (60 loc) · 3.53 KB
Raw

Deriv App

Index

  • General - Contains general philosophy and overview of this package
  • Modules docs - Contains implementation guides (i.e., scaffolding help, etc.)

This repository contains the static HTML, Javascript, CSS, and images content of the Deriv website.

Installation

In order to work on your own version of the Deriv Javascript and CSS, please fork this project.

You will also need to install the following on your development machine:

Use a custom domain

In order to use your custom domain, please put it in a file named CNAME inside scripts folder of your local clone of deriv-app.

How to work with this project

Deploy to your gh-pages for the first time

  1. 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-app/ for the Redirect URL and https://YOUR_GITHUB_USERNAME.github.io/deriv-app/en/redirect for the Verification URL.

    If you're using a custom domain, replace the github URLs above with your domain and remove the deriv-app base path.

  2. In src/config.js: Insert the Application ID of your registered application in user_app_id.

    • NOTE: In order to avoid accidentally committing personal changes to this file, use git update-index --assume-unchanged src/javascript/config.js

  3. Set NODE_ENV to development with export NODE_ENV=development

  4. Run npm run deploy:clean

Deploy to root of gh pages

This will overwrite modified files and only clear the content of js folder before pushing changes. It will leave other folders as they are.

npm run deploy

Clean root and deploy to it

This removes all files and folders and deploys your dist folder to the root.

npm run deploy:clean

Deploy to test folder

This will add all your changes to the test folder specified. Please ensure it is prefixed with br_.

npm run deploy:folder "br_my_test_folder"

Preview on your local machine

  • Edit your /etc/hosts file to include this domain:
127.0.0.1   localhost.binary.sx
  • To preview your changes locally for the first time, run sudo npm start:
    • It will run all tests, compile all css, and js/jsx as well as watch for further js/jsx/css changes and rebuild on every change you make.
  • To preview your changes locally without any tests, run npm run serve
    • It will watch for js/jsx/css changes and rebuild on every change you make.
  • To run all tests, run npm run test

Miscellaneous

  • In Webstorm, right-click on src, hover over Mark directory as, and click Resource root to enable import alias resolution.

Release

Staging

Ensure you have a remote with the name of origin pointing to the deriv-app repo, and that you are on the dev branch.

  1. Navigate to root of project.
  2. Run ./scripts/release-staging.sh

Production

Ensure you have a remote with the name of origin pointing to the deriv-app repo, and production pointing to the deriv-app-production repo, and that you are on the master branch.

  1. Navigate to root of project.
  2. Run ./scripts/release-prod.sh