This repository contains the various platforms of the Deriv application.
- Installation
- Packages in this repo:
- Working With This Repo
- Usage
- PR Guidelines
- FAQ
- General - Contains general philosophy and overview of this package
- Stylesheet guidelines - Contains rules for CSS/SASS code style
- JavaScript guidelines - Contains rules for JS/JSX code style
- Modules docs - Contains implementation guides (i.e., scaffolding, code usage)
In order to work on your own version of the Deriv application, please fork this project.
You will need to perform the following on your development machine:
- Node.js (v12.18.0 is recommended) and NPM (see https://nodejs.org/en/download/package-manager/)
- Clone your own fork of this repo
- Run
npm run bootstrap
from the root folder - If you have a custom domain that you use for GH Pages, add a file named
CNAME
inpackages/core/scripts/
to be used for your GH Pages deployments - Run
npm run build
and then you're good to go
All packages must contain the following scripts to perform the stated actions:
Package param | Command | Description |
---|---|---|
✅ | start |
Runs complete test and build suite and starts the dev server. |
✅ | serve |
Runs build suite and starts the dev server. When serving core , takes optional open value as argument to open specific page. (e.g: npm run serve core --open=bot ) |
✅ | build |
Runs build suite and outputs the result into dist . Takes optional base value as argument. |
✅ | prettify |
Runs prettify script packages(s) to format code as per the specs of the package. |
✅ | test |
Runs the test suite with eslint, and stylelint. |
✅ | test:eslint |
Runs only eslint. |
✅ | test:stylelint |
Runs only stylelint. |
✅ | test:mocha |
Runs only the test suite. |
Please follow the README of each package you intend to work with on how to get set up and their custom scripts. However, the above scripts can be run from the root directory in the following manner.
Each package is named with the @deriv/
prefix, however for the scripts above, you do not need to add the @deriv/
prefix as the scripts already prefix the 1st argument of the script with @deriv/
. However, if you do use the lerna
CLI directly, then you will need to use the full package name including the @deriv/
prefix.
You can find the names of packages by first navigating to the packages
folder. Each subfolder is a package, and contains a package.json
file. The value of the name
key in package.json
is the package name.
If you wish to work on Core, simply run npm run serve core
.
But for working on any of the other packages (such as Trader, Bot, P2P), perform the following:
- Open 2 terminals.
- Run
npm run serve {package name}
in the first one. e.g.:npm run serve translations
,npm run serve bot
, etc. - Then run
npm run serve core
in the second one.
If you intend to remove node_modules
folder(s) from the projects, please run npm run clean
from the root of the project.
This runs lerna clean && rm -rf $(git rev-parse --show-toplevel)/node_modules
under the hood.
You can read more on the various lerna commands (and the clean
command) over at the Lerna docs.
If a script supports the "Package param", you can supply a {package name}
for it to run the script in. At the moment, only 1 package name can be given to a script, if you wish to run in multiple, please use the lerna
command that's used under the hood as per its docs.
✅ In order to run the start
script for the bot
package, simply run:
npm run start bot
✅ Likewise for trader
(or any other package) with a different script:
npm run test:stylelint trader
comment: <> (❌ Below command will not work as the script deploy:clean
does not support "Package param" (refer to the table in Working With This Repo): bash npm run deploy:clean bot
)
There are 2 types of release:
comment: <> (1. Release to test link (deploy to your fork's GH Pages): 1. You can simply deploy to root of the gh-pages
branch with: npm run deploy
. 2. You can clean (remove br_
folders and clear root) your gh-pages
branch and deploy to root in a single command with npm run deploy:clean
3. You can deploy to a folder in your gh-pages
branch in order to separate from root app deployment and other folder deployments with: npm run deploy:folder br_test_folder
(folder name must be prefixed with br_
))
- Release to staging:
git tag staging_v20191205 -m 'release staging'
# the tag needs to follow the RegExp format/^staging.*/
git push origin staging_v20191205
- Release to production:
git tag production_v20191205 -m 'release production'
git push origin production_v20191205
There is a 4th type of release: releasing npm registry packages (currently @deriv/p2p
). This a WIP, but the current method is:
- Acquire membership to
@deriv
npm organization namespace. - Ensure you have a new (bumped) version of publishable packages (currently
@deriv/p2p
). - Run
npm run publish:p2p
. The command publishes all bumped packages. However, right now the name includes the wordp2p
to signal the WIP status and that P2P is the only published package under this repo.
- Use the
developer 1|developer 2/task_name
format for PR titles. (e.g.:dev1|dev2/fixed_emoji_issue
,dev1/added_superfast_jellyfish
)- Optional square bracket tag (e.g.
[WIP]
) can be at the end.
- Optional square bracket tag (e.g.
- Use the appropriate package labels available on the repo to indicate which packages your PR modifies.
- Use Draft PRs if you don't mean to request for reviews yet. Read more here.
-
How do I install an npm package in one of our packages?
A. You can simply
cd
into the package you wish to install to, then runnpm i package-name
as usual. Or simply run alerna exec
likelerna exec --scope=local-package -- npm i npm-package-name
, e.g.:lerna exec --scope=@deriv/translations -- npm i i18next
. Please note that for directlerna
CLI use, you need the full package name including the@deriv/
prefix. -
How do I uninstall an npm package from one of our packages?
A. Just as installing, except the
npm
command you'd run would benpm uninstall
(shortened tonpm un
). e.g.:lerna exec --scope=@deriv/translations -- npm un i18next
. -
How do I run
npm ci
or equivalent (to add dependencies based onpackage-lock.json
?A. You have two options:
- use
lerna exec
with the--scope
argument as the package you want to run the command on, as suchlerna exec --scope=trader -- npm ci
. cd
intopackages/PACKAGE-NAME
and runnpm ci
, as suchcd packages/trader && npm ci
- use
-
Why do I need to run commands with
sudo
?A. You shouldn't need to. The only command that needs privilege is
serve
andstart
and that's because it's on port 443 however, that script prompts you by itself, you do not need to placesudo
.If you face this issue, simply run
sudo chown -R $(whoami) .
from the root of the project. -
My build(s) fail and I can see it related to Node Sass (
node-sass
), what do I do?A. This issue happens when your
node-sass
has itsbinding.node
set to a version of node different from the current projects' one. Please try the following in order:- First run
npx lerna exec -- npm rebuild node-sass
and try building your packages again. - If that doesn't work, try
npm cache clean --force
, followed bynpm run clean
, and thennpm run bootstrap
. - And finally, if that doesn't work then you can read deeper into this StackOverflow post.
- First run