Skip to content

Commit

Permalink
chore: update readme (#1565)
Browse files Browse the repository at this point in the history
  • Loading branch information
balakrishna-deriv authored Apr 3, 2024
1 parent 8b66079 commit 08803dc
Showing 1 changed file with 0 additions and 30 deletions.
30 changes: 0 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 08803dc

Please sign in to comment.