Skip to content

Commit c7e5aea

Browse files
niloofar-derivniloofar-deriv
authored
Merge pull request deriv-com#49 from deriv-com/utils-docs
Utils docs
2 parents 5b6629d + 94f516e commit c7e5aea

27 files changed

+15898
-1
lines changed

‎utils-docs/.gitignore

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎utils-docs/README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
### Installation
6+
7+
```
8+
$ yarn
9+
```
10+
11+
### Local Development
12+
13+
```
14+
$ yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
### Build
20+
21+
```
22+
$ yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Deployment
28+
29+
Using SSH:
30+
31+
```
32+
$ USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```
38+
$ GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

‎utils-docs/babel.config.js

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
// eslint-disable-next-line no-undef
2+
module.exports = {
3+
// eslint-disable-next-line no-undef
4+
presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
5+
};

‎utils-docs/docs/Constants/_category_.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"label": "Constants",
3+
"position": 2,
4+
"link": { "type": "generated-index" }
5+
}

‎utils-docs/docs/Constants/app-id.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# app-id
6+
7+
### environments
8+
9+
```js
10+
real: "green.derivws.com";
11+
demo: "blue.derivws.com";
12+
```
13+
14+
### domainAppId
15+
16+
```js
17+
"deriv.app": "16929";
18+
"app.deriv.com": "16929";
19+
"staging-app.deriv.com": "16303";
20+
"app.deriv.me": "1411";
21+
"staging-app.deriv.me": "1411";
22+
"app.deriv.be": "30767";
23+
"staging-app.deriv.be": "31186";
24+
"binary.com": "1";
25+
"test-app.deriv.com": "51072";
26+
```
27+
28+
### appBrand
29+
30+
```js
31+
appBrand = "deriv";
32+
```

‎utils-docs/docs/Constants/currency.md

+200
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# currency
6+
7+
### type Currency
8+
9+
```js
10+
keyof typeof precision
11+
```
12+
13+
### precision
14+
15+
```JS
16+
AAD: 2;
17+
AED: 2;
18+
AFN: 2;
19+
ALL: 2;
20+
AMD: 2;
21+
ANG: 2;
22+
AOA: 2;
23+
ARS: 2;
24+
AUD: 2;
25+
AWG: 2;
26+
AZN: 2;
27+
BAM: 2;
28+
BBD: 2;
29+
BCH: 8;
30+
BDT: 2;
31+
BGN: 2;
32+
BHD: 3;
33+
BIF: 0;
34+
BMD: 2;
35+
BND: 2;
36+
BOB: 2;
37+
BOV: 2;
38+
BRL: 2;
39+
BSD: 2;
40+
BTC: 8;
41+
BTN: 2;
42+
BUSD: 2;
43+
BWP: 2;
44+
BYN: 2;
45+
BZD: 2;
46+
CAD: 2;
47+
CDF: 2;
48+
CHE: 2;
49+
CHF: 2;
50+
CHW: 2;
51+
CLF: 4;
52+
CLP: 0;
53+
CNY: 2;
54+
COP: 2;
55+
COU: 2;
56+
CRC: 2;
57+
CUC: 2;
58+
CUP: 2;
59+
CVE: 2;
60+
CZK: 2;
61+
DAI: 2;
62+
DJF: 0;
63+
DKK: 2;
64+
DOP: 2;
65+
DZD: 2;
66+
EGP: 2;
67+
ERN: 2;
68+
ETB: 2;
69+
ETC: 8;
70+
ETH: 8;
71+
EUR: 2;
72+
EURS: 2;
73+
eUSDT: 2;
74+
FJD: 2;
75+
FKP: 2;
76+
GBP: 2;
77+
GEL: 2;
78+
GHS: 2;
79+
GIP: 2;
80+
GMD: 2;
81+
GNF: 0;
82+
GTQ: 2;
83+
GYD: 2;
84+
HKD: 2;
85+
HNL: 2;
86+
HRK: 2;
87+
HTG: 2;
88+
HUF: 2;
89+
IDK: 0;
90+
IDR: 2;
91+
ILS: 2;
92+
INR: 2;
93+
IQD: 3;
94+
IRR: 2;
95+
ISK: 0;
96+
JMD: 2;
97+
JOD: 3;
98+
JPY: 0;
99+
KES: 2;
100+
KGS: 2;
101+
KHR: 2;
102+
KMF: 0;
103+
KPW: 2;
104+
KRW: 0;
105+
KWD: 3;
106+
KYD: 2;
107+
KZT: 2;
108+
LAK: 2;
109+
LBP: 2;
110+
LKR: 2;
111+
LRD: 2;
112+
LSL: 2;
113+
LTC: 8;
114+
LYD: 3;
115+
MAD: 2;
116+
MDL: 2;
117+
MGA: 2;
118+
MKD: 2;
119+
MMK: 2;
120+
MNT: 2;
121+
MOP: 2;
122+
MRU: 2;
123+
MUR: 2;
124+
MVR: 2;
125+
MWK: 2;
126+
MXN: 2;
127+
MXV: 2;
128+
MYR: 2;
129+
MZN: 2;
130+
NAD: 2;
131+
NGN: 2;
132+
NIO: 2;
133+
NOK: 2;
134+
NPR: 2;
135+
NZD: 2;
136+
OMR: 3;
137+
PAB: 2;
138+
PAX: 2;
139+
PEN: 2;
140+
PGK: 2;
141+
PHP: 2;
142+
PKR: 2;
143+
PLN: 2;
144+
PYG: 0;
145+
QAR: 2;
146+
RON: 2;
147+
RSD: 2;
148+
RUB: 2;
149+
RWF: 0;
150+
SAR: 2;
151+
SBD: 2;
152+
SCR: 2;
153+
SDG: 2;
154+
SEK: 2;
155+
SGD: 2;
156+
SHP: 2;
157+
SLL: 2;
158+
SOS: 2;
159+
SRD: 2;
160+
SSP: 2;
161+
STN: 2;
162+
SVC: 2;
163+
SYP: 2;
164+
SZL: 2;
165+
THB: 2;
166+
TJS: 2;
167+
TMT: 2;
168+
TND: 3;
169+
TOP: 2;
170+
TRY: 2;
171+
TTD: 2;
172+
TUSD: 2;
173+
tUSDT: 2;
174+
TWD: 2;
175+
TZS: 2;
176+
UAH: 2;
177+
UGX: 0;
178+
USB: 2;
179+
USD: 2;
180+
USDC: 2;
181+
USDK: 2;
182+
UST: 2;
183+
USN: 2;
184+
UYI: 0;
185+
UYU: 2;
186+
UYW: 4;
187+
UZS: 2;
188+
VES: 2;
189+
VND: 0;
190+
VUV: 0;
191+
WST: 2;
192+
XAF: 0;
193+
XCD: 2;
194+
XOF: 0;
195+
XPF: 0;
196+
YER: 2;
197+
ZAR: 2;
198+
ZMW: 2;
199+
ZWL: 2;
200+
```

‎utils-docs/docs/Constants/localstorage.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# localstorage
6+
7+
```JS
8+
activeLoginid = "client.active_loginid";
9+
```
10+
11+
```JS
12+
accountList = "client.account_list";
13+
```
14+
15+
```JS
16+
configAppId = "config.app_id";
17+
```
18+
19+
```JS
20+
configServerURL = "config.server_url";
21+
```
22+
23+
```JS
24+
i18nLanguage = "i18n_language";
25+
```
26+
27+
```JS
28+
uiTheme = "ui.theme";
29+
```
30+
31+
```JS
32+
uiShowReportsDrawer = "ui.show_report_drawer";
33+
```
34+
35+
```JS
36+
uiExpandAccountSwitcher = "ui.expand_account_switcher";
37+
```
38+
39+
```JS
40+
traderLayout = "trader.layout";
41+
```

‎utils-docs/docs/Constants/url.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# url
6+
7+
### Base Domains
8+
9+
```JS
10+
deriv = "deriv.com";
11+
derivMe = "deriv.me";
12+
derivBe = "deriv.be";
13+
14+
supportedDomains = [deriv, derivBe, derivMe];
15+
baseDomain = window.location.hostname.split("app.")[1];
16+
domain = supportedDomains.includes(baseDomain) ? baseDomain : deriv;
17+
```
18+
19+
### Deriv URLs
20+
21+
```JS
22+
binaryBotProduction = `https://bot.${domain}`;
23+
binaryBotStaging = `https://staging-bot.${domain}`;
24+
derivAppProduction = `https://app.${domain}`;
25+
derivAppStaging = `https://staging-app.${domain}`;
26+
derivComProduction = `https://${domain}`;
27+
derivComProductionEU = `https://eu.${domain}`;
28+
derivComStaging = `https://staging.${domain}`;
29+
derivHost = domain;
30+
smartTraderProduction = `https://smarttrader.${domain}`;
31+
smartTraderStaging = `https://staging-smarttrader.${domain}`;
32+
```
33+
34+
### Deriv WhatsApp
35+
36+
```JS
37+
whatsApp = "https://wa.me/35699578341";
38+
```
39+
40+
### QueryParameters
41+
42+
```JS
43+
lang: "lang";
44+
action: "action";
45+
46+
type QueryParameters = keyof typeof queryParameters;
47+
```

0 commit comments

Comments
 (0)