Skip to content

Latest commit

 

History

History
127 lines (91 loc) · 4.08 KB

README.md

File metadata and controls

127 lines (91 loc) · 4.08 KB
Raw

@deriv/core

core/dist is the place where we build the main bundle at

In this document

Other documents

  • Modules docs - Contains implementation guides (i.e., scaffolding help, etc.)

Description

This workspace is the "app instance". It contains singleton services (such as the WS, and base/common stores), as well as singleton UI components.

How to work with this workspace

Adding domain to your machine hosts config

  • 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

Run this workspace

To run and work on this workspace you need to use npm run serve core command.

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: 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 the 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"

Folder Structure

build
    ├── ...
    ├── webpack-config-test.js
docs
    ├── Modules
    |   |── README.md
src
    ├── _common
    ├── App
    |   |── Components
    |   |── Constants
    |   |── Containers
    ├── Assets
    ├── Constants
    ├── Modules
    ├── public
    ├── root_files
    ├── sass
    ├── Services
    ├── Stores
    ├── templates
    ├── Utils
    |   |── Language
    |   |── pwa
    |   |── Validator
    |   |   |──...
    |   |   |── validator.js

Troubleshooting

  • Icon missing: If the icons are missing, you only need to build this workspace. You can do this by running the build command from the root directory (/deriv-app):
npm run build

Miscellaneous

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