From 08803dcb989f2820e737d196266876461621e7e8 Mon Sep 17 00:00:00 2001 From: balakrishna-deriv <56330681+balakrishna-deriv@users.noreply.github.com> Date: Wed, 3 Apr 2024 11:10:35 +0800 Subject: [PATCH] chore: update readme (#1565) --- README.md | 30 ------------------------------ 1 file changed, 30 deletions(-) diff --git a/README.md b/README.md index 58de9003d..1519676e2 100644 --- a/README.md +++ b/README.md @@ -463,36 +463,6 @@ i) `git tag production_v20180901 -m 'release production'` ii) `git push origin production_v20180901` -### Deploy to Github Pages - -As ChartIQ license is tied to the `binary.com` domain name, we provide developers with a `binary.sx` to test out the library on their Github Pages. - -For each feature/fix you want to add we recommend you deploy an instance of SmartCharts for it (e.g. `brucebinary.binary.sx/featureA`, `brucebinary.binary.sx/featureB`). To deploy SmartCharts to your github pages, you first need to setup your `gh-pages` branch: - -1. Make sure you have a `binary.sx` subdomain pointed to your `github.io` page first (e.g. `brucebinary.binary.sx -> brucebinary.github.io`). -2. In your `gh-pages` branch, add a `CNAME` in your project root folder, and push that file to your branch, for example: - -```bash -git checkout -b gh-pages origin/gh-pages # if you already checkout from remote execute: git checkout gh-pages -echo 'brucebinary.binary.sx' > CNAME # substitute with your domain -git add --all -git commit -m 'add CNAME' -git push origin gh-pages -``` - -Here on, to deploy a folder (e.g. `folder_name`): - - npm run build-travis && npm run gh-pages:folder 'myfoldername' - -Now you should be able to see your SmartCharts app on `brucebinary.binary.sx/myfoldername`. - -Alternatively you can deploy directly to the domain itself (note that this **erases all folders**; could be useful for cleanup). In our example, the following command will deploy to `brucebinary.binary.sx`: - - npm run build-travis && echo 'brucebinary.binary.sx' > CNAME && npm run gh-pages - -> Note: `npm run build-travis` will add hashing inside `index.html`; **do not push those changes to git!** - -There may be occasions where you would want to deploy development versions of the webpack bundles. Quick way to do this is to change the [`--mode` parameter](https://webpack.js.org/concepts/mode/) in `build` npm command in `package.json` to from `production` to `development`. ## Manage translations