forked from binary-com/deriv-app
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
shayan / cfd documentation updated (binary-com#5800)
* docs/ cfd readme.md updated * Update README.md * docs/ Readme file updated * docs/ readme file updated * docs/ Update packages/cfd/README.md Co-authored-by: Yashim Wong <75345074+yashim-deriv@users.noreply.github.com> * docs/ Update packages/cfd/README.md Co-authored-by: Yashim Wong <75345074+yashim-deriv@users.noreply.github.com> * docs /Update packages/cfd/README.md Co-authored-by: Yashim Wong <75345074+yashim-deriv@users.noreply.github.com> * docs/ update readme file * doc/ updated readme file * doc/ updated readme file * doc/ updated readme file Co-authored-by: Yashim Wong <75345074+yashim-deriv@users.noreply.github.com>
- Loading branch information
1 parent
1ac815a
commit ea42c93
Showing
1 changed file
with
40 additions
and
76 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,97 +1,61 @@ | ||
| # Deriv App | ||
| # CFD (contract for difference) | ||
|
|
||
| This repository contains the static HTML, Javascript, CSS, and images content of the [Deriv](http://app.deriv.com) website. | ||
| This repository is a workspace of [deriv-app](../../README.md) monorepo and contains the static HTML, Javascript, CSS, and images content of the [Deriv](http://app.deriv.com) website. | ||
| This workspace covers [DMT5](https://app.deriv.com/mt5) and [Deriv X](https://app.deriv.com/derivx) platforms. | ||
|
|
||
| **In this document** | ||
| ## How to Install the Project | ||
|
|
||
| - [Other documents](#other-documents) | ||
| - [Installation](#installation) | ||
| - [How to work with this project](#how-to-work-with-this-project) | ||
| - [Deploy to your gh-pages for the first time](#deploy-to-your-gh-pages-for-the-first-time) | ||
| - [Deploy to the root of the gh-pages](#deploy-to-the-root-of-the-gh-pages) | ||
| - [Clean root and deploy to it](#clean-root-and-deploy-to-it) | ||
| - [Deploy to test folder](#deploy-to-test-folder) | ||
| - [Preview on your local machine](#preview-on-your-local-machine) | ||
| - [Miscellaneous](#Miscellaneous) | ||
| - [Selenium tests](#selenium-tests) | ||
| You need to follow the instructions [here](../../README.md). | ||
|
|
||
| ## Other documents | ||
| ## How To Work With This Project | ||
|
|
||
| - [Modules docs](docs/Modules/README.md) - Contains implementation guides (i.e., scaffolding, code usage) | ||
| To run and work on this workspace you need to use `npm run serve cfd` command along with `npm run serve core`. | ||
| Webpack will watch changes in `cfd` so that if you made any changes in this package, it will automatically rebuild `cfd` and recompile `core`. | ||
|
|
||
| ## Installation | ||
| ## Folder Structure | ||
|
|
||
| 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: | ||
|
|
||
| - 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` | ||
|
|
||
| ### 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](https://developers.binary.com/applications/). 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/config.js` | ||
|
|
||
| 3. Set `NODE_ENV` to `development` with `export NODE_ENV=development` | ||
|
|
||
| 4. Run `npm run deploy:clean` | ||
|
|
||
| ### Deploy to the root of the 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. | ||
|
|
||
| ```sh | ||
| npm run deploy | ||
| ``` | ||
| build | ||
| ├── ... | ||
| ├── webpack-config.js | ||
| src | ||
| ├── _common | ||
| ├── Components | ||
| ├── Constants | ||
| ├── Containers | ||
| ├── Helpers | ||
| ├── Modules | ||
| | |──Page404 | ||
| ├── ... | ||
| ├── Store | ||
| ├── ... | ||
| ├── Utils | ||
| │ ├── Validator | ||
| | | ├──... | ||
| | | ├── validator.js | ||
| ### Clean root and deploy to it | ||
|
|
||
| This removes all files and folders and deploys your `dist` folder to the root. | ||
| ```sh | ||
| npm run deploy:clean | ||
| ``` | ||
|
|
||
| ### Deploy to test folder | ||
| **Components:** This folder contains all the reusable components we need for developing the project. | ||
|
|
||
| This will add all your changes to the test folder specified. | ||
| Please ensure it is prefixed with `br_`. | ||
| **Constants:** We add the static data structures needed for the project here. | ||
| We have a separate folder for each component. | ||
|
|
||
| ```sh | ||
| npm run deploy:folder "br_my_test_folder" | ||
| ``` | ||
| **Containers:** This folder contains the wrappers we use for the whole project. | ||
|
|
||
| ### Preview on your local machine | ||
| **Modules:** This folder contains the 404 page component. | ||
|
|
||
| - Edit your `/etc/hosts` file to include this domain: | ||
| **Stores:** We use Mobx as state management tool in cfd, and this is the place for putting the relevant store files. Also, for each store file we have a test file in **tests** folder. | ||
|
|
||
| ``` | ||
| 127.0.0.1 localhost.binary.sx | ||
| ``` | ||
| **templates:** includes two different styles of loading component which are used in the whole workspace | ||
|
|
||
| - 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` | ||
| **Helpers and Utils:** We place all the common and helper methods which are required for the project in this folder. | ||
|
|
||
| ## Miscellaneous | ||
| ## Troubleshooting | ||
|
|
||
| - In Webstorm, right-click on `src`, hover over `Mark directory as`, and click `Resource root` to enable import alias resolution. | ||
| - **Icon missing:** If the icons are missing, you only need to build this project. You can do this by running the build command from the root directory (`/deriv-app`): | ||
|
|
||
| ## Selenium tests | ||
|
|
||
| Elements for selenium test purposes should have `id` attributes, with the value of `dt_[element_name]_[unique_name|id]_[element_type]`. (e.g. `dt_settings_dark_button`) | ||
| ```console | ||
| npm run build | ||
| ``` |