From 932a67d448da4aaaefaf3a593fd6a859f1179ccc Mon Sep 17 00:00:00 2001 From: sara-fs Date: Sun, 20 Jun 2021 08:49:25 +0430 Subject: [PATCH 01/12] Updated readme file --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 48972f278fb..385bd5e3f4e 100644 --- a/README.md +++ b/README.md @@ -41,19 +41,35 @@ Moreover, having these extensions will help you to speed up the development proc ## Quick start -1. **Install your dependencies:** +1. **Fork the project** + + In order to work on your own version of the Deriv application, please fork the project to your own repo. + +2. **Clone using SSH** + + ```sh + git clone git@github.com:your-github-username/deriv-com.git + ``` + +3. **Enter project directory** + + ```sh + cd deriv-com + ``` + +4. **Install your dependencies:** ```sh npm ci ``` -2. **To start developing:** +5. **To start developing:** ```sh npm start ``` -3. **Open the source code and start editing!** +6. **Open the source code and start editing!** Your site is now running at `http://localhost:8000`! From c0263cd0f5558c4bbd4896e3d42b375e6cb3eed6 Mon Sep 17 00:00:00 2001 From: Hojjat Jokar Date: Tue, 13 Jul 2021 17:38:41 +0430 Subject: [PATCH 02/12] docs: update and fix grammaratic issues --- README.md | 75 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 38 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 385bd5e3f4e..4c55cbf1365 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,20 @@ Deriv.com +This is the source code for Deriv.com + ## In this document: -- [In this document:](#in-this-document) -- [Other Documents](#other-documents) -- [Pre-installation](#pre-installation) -- [Quick start](#quick-start) -- [How to contribute](#how-to-contribute) - - [Base master](#base-master) - - [Base crowdin](#base-crowdin) -- [Manage translations](#manage-translations) -- [Manage releases](#manage-releases) -- [Test link deployment](#test-link-deployment) -- [FAQ](#faq) +- [Other Documents](#other-documents) +- [Pre-installation](#pre-installation) +- [Quick start](#quick-start) +- [How to contribute](#how-to-contribute) + - [Base master](#base-master) + - [Base Crowdin](#base-crowdin) +- [Manage translations](#manage-translations) +- [Manage releases](#manage-releases) +- [Test link deployment](#test-link-deployment) +- [FAQ](#faq) ## Other Documents @@ -26,7 +27,7 @@ ## Pre-installation -Before running or contribute to this project, you need to have the following packages setup in your environment +Before running or contribute to this project, you need to have the setup of the following packages in your environment - node - npm @@ -45,13 +46,13 @@ Moreover, having these extensions will help you to speed up the development proc In order to work on your own version of the Deriv application, please fork the project to your own repo. -2. **Clone using SSH** +2. **Clone using SSH** ```sh git clone git@github.com:your-github-username/deriv-com.git ``` -3. **Enter project directory** +3. **Enter project directory** ```sh cd deriv-com @@ -81,9 +82,9 @@ We have two types of PR (Pull request): ### Base master -PR will be based on master branch if the commits are not having text changes +PR will be based on the master branch if the commits are not having text changes -1. Create branch from latest master branch +1. Create branch from the latest master branch ```sh git checkout master @@ -91,7 +92,7 @@ PR will be based on master branch if the commits are not having text changes git checkout -b [_your_branch_name] ``` -2. MAKE YOUR CHANGES +2. Make your changes 3. Make pull request @@ -101,17 +102,17 @@ PR will be based on master branch if the commits are not having text changes git push -u origin [_your_branch_name] ``` -- Click on the autogenerated link from terminal to open the PR +- Click on the autogenerated link from the terminal to open the PR - Make sure to change the PR base to `master` branch -### Base crowdin +### Base Crowdin PR will be based on crowdin branch if the commits are having text changes 1. Create branch from latest crowdin branch -- if you dont have crowdin branch +- if you don't have crowdin branch ```sh git fetch upstream crowdin:crowdin @@ -127,11 +128,11 @@ PR will be based on crowdin branch if the commits are having text changes git checkout -b [_your_branch_name] ``` -2. MAKE YOUR CHANGES +2. Make your changes 3. Extract translation -- Make sure you have the latest crowdin changes, resolve conflicts if any +- Make sure you have the latest Crowdin changes, resolve conflicts if any ```sh git pull upstream crowdin @@ -168,21 +169,21 @@ PR will be based on crowdin branch if the commits are having text changes brew install crowdin ``` - - Set up your crowdin API KEY in your .bash_profile or .zshrc + - Set up your Crowdin API KEY in your .bash_profile or .zshrc -- To upload source text to crowdin (When task merge to crowdin branch) +- To upload source text to Crowdin (When task merge to crowdin branch) ```sh npm run translate:upload ``` -- To download/get latest crowdin translations +- To download/get the latest Crowdin translations ```sh npm run translate:download ``` -Note\*: Don't forget to create a pull request to update crowdin branch +**Note**: Don't forget to create a pull request to update crowdin branch ## Manage releases @@ -190,25 +191,25 @@ There are 2 types of releases: 1. Release to staging: -Merging to master (squash and merge) will automatically release last commit to staging server https://staging.deriv.com +Merging to master (squash and merge) will automatically release the last commit to the staging server https://staging.deriv.com -⚠️ If you want to release crowdin change, please make a PR from crowdin to master branch +⚠️ If you want to release Crowdin changes, please make a PR from crowdin to master branch 2. Release to production: -Releasing to production require a tag using the following format: +Releasing to production requires a tag using the following format: `production_VYYYYMMDD_${Integer}` --- Integer is the release version Example of release steps -- Create the tag following todays date +- Create the tag following today's date ```sh git tag production_V20200806_0 -m 'release to production' ``` -- Push tag to main repository +- Push the tag to the main repository ```sh git push upstream production_V20200806_0 @@ -220,11 +221,11 @@ There are two types of test link deployment preview: 1. Automatic deployment -Upon creating PR, `vercel` (https://vercel.com/) will auto-generate test link inside the PR. you can use that to preview test link for the changes you have made. +Upon creating PR, [Vercel](https://vercel.com/) will auto-generate a test link inside the PR. you can use that to preview the test link for the changes you have made. 2. Manual deployment -If preferrable to use manual deployment, you can use gh-pages functionality to create test link. here are ways to do it: +If preferable to use manual deployment, you can use [gh-pages](https://pages.github.com/) functionality to create a test link. here are ways to do it: - **Basic name.github.io/deriv-com/** @@ -242,13 +243,13 @@ If preferrable to use manual deployment, you can use gh-pages functionality to c This will be deployed to name.github.io/deriv-com/br/fix_all_the_bugs -⚠️ You have to enable pathPrefix in gatsby-config for manual deployment, otherwise the resources will not be uploaded to the site +⚠️ You have to enable pathPrefix in gatsby-config for manual deployment, otherwise, the resources will not be uploaded to the site ## FAQ -- [how to create new page?](documents/implementation-guide.md#create-new-page) -- [how to insert image?](documents/implementation-guide.md#image-component) +- [how to create a new page?](documents/implementation-guide.md#create-new-page) +- [how to insert an image?](documents/implementation-guide.md#image-component) - [how to style my element?](documents/implementation-guide.md#styled-component) - [Where to put my new component?](documents/file-structures.md) -⚠️ If you have more to questions to add, please open a PR to add question in FAQ section. Answer will be on the PR reviews +⚠️ If you have more questions to add, please open a PR to add your question in FAQ section. The Answer will be on the PR reviews From 3d44de0b09971fdc7513d33d70ef667f16e73665 Mon Sep 17 00:00:00 2001 From: Hojjat Jokar Date: Wed, 14 Jul 2021 13:29:03 +0430 Subject: [PATCH 03/12] doc: update implementation guide --- documents/implementation-guide.md | 152 ++++++++++++++++-------------- 1 file changed, 80 insertions(+), 72 deletions(-) diff --git a/documents/implementation-guide.md b/documents/implementation-guide.md index de811430760..e1adb2dd0be 100644 --- a/documents/implementation-guide.md +++ b/documents/implementation-guide.md @@ -1,14 +1,26 @@ -## Implementation guide +# General Implementation guide -### Styled Component +**In this Document** -to use styled component you can import it +- [Styled Component](#styled-component) +- [Image Component](#image-component) +- [Translation / Localization](#translation-/-localization) +- [Mobile responsive](#mobile-responsive) +- [CSS responsive function](#css-responsive-function) +- [Create new page](#create-new-page) +- [Handling EU or NonEU Views](#handling-eu-or-noneu-views) + +## Styled Component + +To use a styled component you can follow this step: + +1. Import it ```js import styled from 'styled-components' ``` -to use it you can create a function using the imported `styled` +2. For extending styles of a html element using the imported `styled` ```js const _component_name_ = styled._any_html_tag` @@ -26,44 +38,41 @@ const _component_name_ = styled._any_html_tag` ` ``` -Then in your react component +Also you can extend styled component like this ```js -<_component_name_> - - +const _want_extend_ = styled(_component_name_)` + _your_css_style_ +` ``` -you can extend styled component like this +3. Then in your react component ```js -const _want_extend_ = styled(_component_name_)` - _your_css_style_ -` +<_component_name_> + + ``` -*noted that we are using `rem` as value where `10px = 1rem`, the rem configuration can be found at `themes/global-style.js` -*for further information you can take a look at [Styled Component](https://www.styled-components.com/) +**Note:** Use `rem` as length unit where `10px = 1rem`, the rem configuration can be found at `themes/global-style.js` -### Image Component +For further information you can take a look at [Styled Component Documentation](https://styled-components.com/docs) -#### (png|jpg|jpeg|gif) file type +## Image Component -image will be located anywhere within `src/images/common` directory. -this project uses GatsbyImageSharpFluid lazy load image built in gatsby-iamge. for further information, can take a look at [Gatsby Image](https://www.gatsbyjs.org/packages/gatsby-image), the configuration is located at -`src/components/elements/image.js`. +### (png|jpg|jpeg|gif) file type + +An image will be located anywhere within `src/images/common` directory. +This project uses `GatsbyImage` built in gatsby-plugin-image. For further information, can take a look at [Gatsby Image plugin](https://www.gatsbyjs.com/docs/reference/built-in-components/gatsby-plugin-image/#gatsbyimage), the configuration is located at +`src/components/elements/query-image.js`. Usage example: ```js -_image_alt_ +_image_alt_ ``` -#### (svg) file type +### (svg) file type svg will be located anywhere within `src/images/svg` directory. SVG will be handled by `gatsby-plugin-react-svg` which overriding `svg-react-loader`, you can take a look at [Gatsby SVG](https://www.gatsbyjs.org/packages/gatsby-plugin-react-svg/) @@ -75,9 +84,9 @@ import { ReactComponent as Logo } from 'images/svg/logo-header.svg' ; ``` -### Translation / Localization +## Translation / Localization -translation functions and component located within `src/components/localization` directory. +Translation functions and component located within `src/components/localization` directory. text translation use `react-i18next`, you can take a look at [react-i18next](https://react.i18next.com/) for more information. Usage example: @@ -97,13 +106,13 @@ import { localize, Localize } from 'components/localization'

``` -### Mobile responsive +## Mobile responsive Mobile responsive device breakpoints can be found in this directory `themes/device` -#### CSS changes +### CSS changes -to configure responsiveness based on css changes, you can use `@media` +To configure responsiveness based on css changes, you can use `@media` Usage example: @@ -118,9 +127,9 @@ const YourCssStyle = styled.div` ` ``` -#### JS changes +### JS changes -to configure responsiveness based on js changes or different component render, you can use `Show` component in `/containers` directory +to configure responsiveness based on JS changes or different component render, you can use `Show` component in `/containers` directory Usage example (chain): @@ -154,10 +163,40 @@ const Example = () => ( ) ``` -#### Create new page +## CSS responsive function + +To create a responsive component for different breakpoints, please use `` component and inject the CSS styles for available breakpoints. -to create new page, please create a directory inside `src/pages`. directory name automatically become the new route, -create an index.js inside the directory (this is required). To separate into different sections, you can make another js file inside the directory with prefix `_` to avoid creation of new route. +Usage example: + +```js +import { Box } from 'components/containers' + +const UseResponsiveCss = () => { + return ( + + component here + + ) +} +``` + +## Create new page + +To create a new page, please create a directory inside `src/pages`. Directory name automatically becomes the new route, +create an `index.js` inside the directory (this is required). To separate into different sections, you can make another JS file inside the directory with prefix `_` to avoid creation of new route. Example directory: @@ -168,9 +207,8 @@ Example directory: │ ├── ... ``` -Every page should be wrapped within `` component, and have a child ``. -It is required to export default your page. and use Higher order component of `WithIntl` from localization to help usage of translation methods. - +Every page should be wrapped within `` component, and also it should contain a child ``. +It is required to export default your page with a Higher-order component of `WithIntl` from localization to help the usage of translation methods. Usage example: ```js @@ -190,39 +228,9 @@ const MyPageName = () => { export default WithIntl()(MyPageName) ``` -### CSS responsive function - -to create a responsive component for different breakpoints, please use `` component and inject the css styles for available breakpoints. - -Usage example: - -```js -import { Box } from 'components/containers' - -const UseResponsiveCss = () => { - return ( - - component here - - ) -} -``` - -### Handling EU or NonEU Views +## Handling EU or NonEU Views -to handle visibility of europe countries, you can use `Show` component in `/containers` directory. Eu countries list are located in `common/country-base.js` +To handle the visibility for European countries, you can use `Show` component in `/containers` directory. Eu countries list are located in `common/country-base.js` Usage example (chain): @@ -233,9 +241,9 @@ const Example = () => (

Test!

- you are in europe countries + You are in europe countries - you are in non-europe countries + You are in non-europe countries
) ``` From a42576146b15b6e50890b7578aaec5845448a652 Mon Sep 17 00:00:00 2001 From: Hojjat Jokar Date: Wed, 14 Jul 2021 13:53:03 +0430 Subject: [PATCH 04/12] doc: update development guidelines --- README.md | 2 +- documents/{developer-guide.md => development-guidelines.md} | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) rename documents/{developer-guide.md => development-guidelines.md} (65%) diff --git a/README.md b/README.md index 4c55cbf1365..495c18841f3 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ This is the source code for Deriv.com ## Other Documents - [General implementation](documents/implementation-guide.md) - Contain ways to do development in deriv.com -- [Developer guide](documents/developer-guide.md) - Contain advice for developers working on this project +- [Development Guidelines](documents/development-guidelines.md) - Contain advice for developers working on this project - [Git best practice](documents/git-best-practices.md) - Contain git practices and commit guidelines - [File structures](documents/file-structures.md) - [GTM Workflow](documents/gtm-workflow.md) - Contains Google Tag Manager workflow and additional information diff --git a/documents/developer-guide.md b/documents/development-guidelines.md similarity index 65% rename from documents/developer-guide.md rename to documents/development-guidelines.md index 42cd409b0ed..3fcaa0c6bb8 100644 --- a/documents/developer-guide.md +++ b/documents/development-guidelines.md @@ -3,10 +3,10 @@ ## Do: - Keep all files immediately relevant to a component inside the given component directory. -- make it dead simple to import the component from elsewhere. -- Feel free to create subdirectories for relevant utils or helpers +- Make it dead simple to import the component from elsewhere. +- Feel free to create sub-directories for relevant utils or helpers if it helps to keep things tidy -- Keep components small, focused and easy to test, breaking up complex components into smaller components +- Keep components small, focused, and easy to test, breaking up complex components into smaller components - Try to create new, reusable components instead of "sub-components" (i.e. prefer not to create sub-directories that contain more components) - **Be consistent** — however, you choose to lay things out From 454830c1f287d331950d0dcf736d2ecd8a809381 Mon Sep 17 00:00:00 2001 From: Hojjat Jokar Date: Wed, 14 Jul 2021 14:07:02 +0430 Subject: [PATCH 05/12] docs: update git best practices doc --- documents/git-best-practices.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/documents/git-best-practices.md b/documents/git-best-practices.md index 021cd262f7f..7819e668a54 100644 --- a/documents/git-best-practices.md +++ b/documents/git-best-practices.md @@ -1,8 +1,15 @@ +# Git best practices + +**In this document:** + +- [Commit message guidelines](#commit-message-guidlines) +- + ## Commit message guidelines -We have a precise rules over how our git commit messages can be formatted. This leads to more **readable messages** that are easy to follow when looking through the **project history**. +We have a set of precise rules over how our git commit messages can be formatted. This leads to more **readable messages** that are easy to follow when looking through the **project history**. -Each commit message will consists of **type** and **subject**: +Each commit message will consist of **type** and **subject**: ```sh |<...other_types>: @@ -27,7 +34,7 @@ Must be one of the following: ## Changing base branch -There are cases when you want to change the base branch because the PR that didn't used to have text changes is now having text changes, so, you need to convert base branch from `master` to `crowdin`. The command to do that is as follows: +There are cases when you want to change the base branch because the PR that didn't have text changes is now having text changes, so, you need to convert the base branch from `master` to `crowdin`. The command to do that is as follows: ```sh git rebase --onto crowdin master your_branch_name @@ -41,7 +48,7 @@ git rebase --onto master crowdin your_branch_name ## Get latest Changes -There are two ways to get latest changes: +There are two ways to get the latest changes: ```sh git pull upstream master|crowdin --rebase @@ -57,20 +64,20 @@ both of these will do the job. However, rebase won't add another commit to your ## Resolve translation conflict on message.json -There are cases when other developers also work on translation (crowdin) branch, and get merged first. This way, your branch will get conflict of the extracted message.json. to fix this: +There are cases when other developers also work on translation (crowdin) branch, and get merged first. This way, your branch will get conflict of the extracted message.json. To fix this: -- get the latest crowdin changes +- Get the latest Crowdin changes ```sh git pull upstream crowdin ``` -- accept incoming change from crowdin +- Accept incoming change from Crowdin ```sh git checkout --theirs crowdin/messages.json ``` -- resolve other conflicts if any, or just commit your changes +- Resolve other conflicts if any, or just commit your changes -- push to your origin branch to update the PR +- Push to your origin branch to update the PR From ad573d0102f9321140edceda437064de0d7330cb Mon Sep 17 00:00:00 2001 From: Hojjat Jokar Date: Wed, 14 Jul 2021 14:13:59 +0430 Subject: [PATCH 06/12] docs: add table of content to git doc --- documents/git-best-practices.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/documents/git-best-practices.md b/documents/git-best-practices.md index 7819e668a54..ff29239aabd 100644 --- a/documents/git-best-practices.md +++ b/documents/git-best-practices.md @@ -3,7 +3,10 @@ **In this document:** - [Commit message guidelines](#commit-message-guidlines) -- + - [Type](#type) +- [Changing base branch](#changing-base-branch) +- [Get latest Changes](#get-latest-changes) +- [Resolve translation conflict on message.json](#resolve-translation-conflict-on-message.json) ## Commit message guidelines From 5f0a388e7e9d30a118d8e63a42cec276ef9615f9 Mon Sep 17 00:00:00 2001 From: Hojjat Jokar Date: Wed, 14 Jul 2021 14:53:11 +0430 Subject: [PATCH 07/12] docs: update gtm workflow --- documents/gtm-workflow.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/documents/gtm-workflow.md b/documents/gtm-workflow.md index dc97472aa16..b580d482b40 100644 --- a/documents/gtm-workflow.md +++ b/documents/gtm-workflow.md @@ -1,30 +1,37 @@ -## Google Tag Manager Workflow +# Google Tag Manager Workflow -### Introduction: +**In this document:** -Google Tag Manager is a tool with a user-friendly, web-based interface that simplifies the process of working with tags. With GTM, you’re able to add, edit, and disable tags without having to touch the source code. If there's another tag which doesn't have a template in GTM, you can add your own custom code. Using Deriv’s tag manager account, you can redirect to `Default Workspace`, under `Tags` tab you will see all our customised tags that have been created. -Main point of this document is to familiarise user with how certain tags such as `Trade Deriv - Event Button Click` works and how we can add custom variables and make use of them in our tag. +- [Introduction](#introduction) +- [Required Information](#required-information) +- [Custom Tag](#custom-tag) +- [Create Custom Variable](#create-custom-variable) -### Required Information +## Introduction: -**Tag**: A tag is code that send data to a system such as Google Analytics. +Google Tag Manager is a tool with a user-friendly, web-based interface that simplifies the process of working with tags. With GTM, you’re able to add, edit, and disable tags without having to touch the source code. If there's another tag that doesn't have a template in GTM, you can add your own custom code. Using Deriv’s tag manager account, you can redirect to `Default Workspace`, under `Tags` tab you will see all our customised tags that have been created. +The main point of this document is to familiarise users with how certain tags such as `Trade Deriv - Event Button Click` works and how we can add custom variables and make use of them in our tag. + +## Required Information + +**Tag**: A tag is a code that sends data to a system such as Google Analytics. `Custom Tag`: Trade Deriv - Event Button Click **Trigger**: A trigger listens for certain events, such as clicks, form submissions, or page loads. When an event is detected that matches the trigger definition, any tags that reference that trigger will fire. `Custom Trigger`: Trade Deriv - Button Click -**Variable**: A variable is a named placeholder for a value that will change, such as a product name, a price value, or a date and in our case we have below variables. +**Variable**: A variable is a named placeholder for a value that will change, such as a product name, a price value, or a date and in our case, we have the below variables. `User-Defined Variables`: - event category da - event action da - event label da -**Data layer**: Tag manager implements a data layer to temporarily hold values in the client so that they can be used by tags, triggers, and variables. +**Data layer**: The tag manager implements a data layer to temporarily hold values in the client so that they can be used by tags, triggers, and variables. -### Custom Tag: Trade Deriv - Event Button Click +## Custom Tag: Trade Deriv - Event Button Click -This tag is of type `Google Analytics: Universal Analytics` to track `Events` providing 4 parameters such as `Category`, `Action`, `Label` and `Value` of that event. To make use of this tag, we simply need to add a custom javascript data attribute namely `data-custom-events` on our clickable element which equals to a comma-separated value as below. +This tag is of type `Google Analytics: Universal Analytics` to track `Events` providing 4 parameters such as `Category`, `Action`, `Label`, and `Value` of that event. To make use of this tag, we simply need to add a custom Javascript data attribute namely `data-custom-events` on our clickable element which equals to a comma-separated value as below. ```js @@ -43,7 +50,7 @@ This tag is of type `Google Analytics: Universal Analytics` to track `Events` pr Upon starting `Tag Manager Preview Mode`, in the website, you can click on the button with the specific data attribute, it will trigger the action event which contain the value of `click_button`, it will provide all the `Tag Details Properties` and our defined `Variables` along with their respective values. -### Create Custom Variable +## Create Custom Variable To create a custom variable, you need to go to `Variables` tab in GTM and follow the steps below: From ae39aee3e167ae33d1d415cd4b6d45869f7ea30e Mon Sep 17 00:00:00 2001 From: Hojjat Jokar Date: Thu, 15 Jul 2021 07:53:12 +0430 Subject: [PATCH 08/12] docs: add badge to readme --- README.md | 6 ++++-- package.json | 4 ++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 495c18841f3..55547320c4e 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ This is the source code for Deriv.com +![GitHub Workflow Status](https://img.shields.io/github/workflow/status/binary-com/deriv-com/Release%20Staging) ![node](https://img.shields.io/badge/node-%3E%3D12.3.0-blue.svg) ![npm](https://img.shields.io/badge/npm-%3E%3D6.9.0-blue.svg) [![GATSBY](https://img.shields.io/badge/Gatsby-663399?style=flat&logo=gatsby&logoColor=white)](https://github.com/styled-components/styled-components) [![style: styled-components](https://img.shields.io/badge/style-%F0%9F%92%85%20styled--components-orange.svg?colorB=daa357&colorA=db748e)](https://github.com/styled-components/styled-components) + ## In this document: - [Other Documents](#other-documents) @@ -29,8 +31,8 @@ This is the source code for Deriv.com Before running or contribute to this project, you need to have the setup of the following packages in your environment -- node -- npm +- node >=12.3.0 +- npm >=6.9.0 - git (for `contribution`) - gatsby-cli (npm install -g gatsby-cli) diff --git a/package.json b/package.json index dab3029c8d0..e13b7c9a31a 100644 --- a/package.json +++ b/package.json @@ -98,5 +98,9 @@ }, "bugs": { "url": "https://github.com/binary-com/deriv-com/issues" + }, + "engines": { + "npm": ">=6.9.0", + "node": ">=12.3.0" } } From f2b2726e7b46e5df9a50831721ad61c01aa5910e Mon Sep 17 00:00:00 2001 From: Hojjat Jokar Date: Thu, 15 Jul 2021 09:48:56 +0430 Subject: [PATCH 09/12] docs: update description --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 55547320c4e..330726f35e1 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,10 @@ Deriv.com -This is the source code for Deriv.com +Deriv.com - An online trading platform that offers a wide selection of derivatives to trade on 24/7. -![GitHub Workflow Status](https://img.shields.io/github/workflow/status/binary-com/deriv-com/Release%20Staging) ![node](https://img.shields.io/badge/node-%3E%3D12.3.0-blue.svg) ![npm](https://img.shields.io/badge/npm-%3E%3D6.9.0-blue.svg) [![GATSBY](https://img.shields.io/badge/Gatsby-663399?style=flat&logo=gatsby&logoColor=white)](https://github.com/styled-components/styled-components) [![style: styled-components](https://img.shields.io/badge/style-%F0%9F%92%85%20styled--components-orange.svg?colorB=daa357&colorA=db748e)](https://github.com/styled-components/styled-components) +![GitHub Workflow Status](https://img.shields.io/github/workflow/status/binary-com/deriv-com/Release%20Staging) ![node](https://img.shields.io/badge/node-%3E%3D12.3.0-blue.svg) ![npm](https://img.shields.io/badge/npm-%3E%3D6.9.0-blue.svg) [![GATSBY](https://img.shields.io/badge/Gatsby-663399?style=flat&logo=gatsby&logoColor=white)](https://github.com/styled-components/styled-components) [![style: styled-components](https://img.shields.io/badge/style-%F0%9F%92%85%20styled--components-orange.svg?colorB=daa357&colorA=db748e)](https://github.com/styled-components/styled-components) ![Sonar Violations (short format)](https://img.shields.io/sonar/violations/DerivFE_deriv-com?label=sonar%20violation&server=https%3A%2F%2Fsonarcloud.io) +![Sonar Tech Debt](https://img.shields.io/sonar/tech_debt/DerivFE_deriv-com?server=http%3A%2F%2Fsonarcloud.io) ## In this document: From 84184b64d483b8fb27c6a563cd359ae388f64664 Mon Sep 17 00:00:00 2001 From: Hojjat Jokar Date: Thu, 15 Jul 2021 09:57:16 +0430 Subject: [PATCH 10/12] docs: update table of contents --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 330726f35e1..38dfc1896f3 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ Deriv.com - An online trading platform that offers a wide selection of derivativ - [Git best practice](documents/git-best-practices.md) - Contain git practices and commit guidelines - [File structures](documents/file-structures.md) - [GTM Workflow](documents/gtm-workflow.md) - Contains Google Tag Manager workflow and additional information +- [Translation Workflow](documents/translation-workflow.md) - Contains general workflow and commands required for our translation process ## Pre-installation @@ -35,7 +36,7 @@ Before running or contribute to this project, you need to have the setup of the - node >=12.3.0 - npm >=6.9.0 - git (for `contribution`) -- gatsby-cli (npm install -g gatsby-cli) +- gatsby-cli (npm install -g gatsby-cli) (for using commands that aren't listed in scripts) Moreover, having these extensions will help you to speed up the development process and adhere to the best practices From c51931c43cb7b649f58ec8241a2d1affdefe4552 Mon Sep 17 00:00:00 2001 From: hojjat-fs <78338781+hojjat-fs@users.noreply.github.com> Date: Mon, 26 Jul 2021 11:19:48 +0430 Subject: [PATCH 11/12] Update README.md Co-authored-by: Sean Ho <72253841+sean-binary@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 38dfc1896f3..3ab505e29b8 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ Moreover, having these extensions will help you to speed up the development proc We have two types of PR (Pull request): -### Base master +### Base **Master** PR will be based on the master branch if the commits are not having text changes From 9582e92f5c081c8984bb26a5280e0aa1d0e641c1 Mon Sep 17 00:00:00 2001 From: hojjat-fs <78338781+hojjat-fs@users.noreply.github.com> Date: Mon, 26 Jul 2021 11:20:01 +0430 Subject: [PATCH 12/12] Update README.md Co-authored-by: Sean Ho <72253841+sean-binary@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3ab505e29b8..e4a5b40634c 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Deriv.com - An online trading platform that offers a wide selection of derivativ ## Other Documents - [General implementation](documents/implementation-guide.md) - Contain ways to do development in deriv.com -- [Development Guidelines](documents/development-guidelines.md) - Contain advice for developers working on this project +- [Development guidelines](documents/development-guidelines.md) - Contain advice for developers working on this project - [Git best practice](documents/git-best-practices.md) - Contain git practices and commit guidelines - [File structures](documents/file-structures.md) - [GTM Workflow](documents/gtm-workflow.md) - Contains Google Tag Manager workflow and additional information