webtrader charts
npm install @binary-com/webtrader-chartsThe charting library extracted from Webtrader is used for binary-static and webtrader.
- Other Documents
- Pre-installation
- Quick start
- How to contribute
- Manage translations
- Deploying to gh-pages
- Publishing to npm
- General implementation - Contain ways to use the library
Before running or contribute to this project, you need to have the setup of the following packages in your environment
- node
- npm
- git
1. Fork the project
In order to work on your own version, please fork the project to your own repo.
2. Clone using SSH
``sh`
git clone git@github.com:your-github-username/webtrader-charts.git
3. Enter project directory
`sh`
cd webtrader-charts
4. Change output folder:
- Change rollup.config.js to write the output into /example folder.
**NOTE: you can change the dist file config in rollup.config.js by uncommenting the file prop for example, webtrader or binary-static
5. Install your dependencies:
- run the following command on both main project and /example folder:
`sh`
npm install
6. Start developing:
- run the following command on both main project and /example folder:
`sh`
npm run watch
7. Open the source code and start editing!
Your site is now running at http://localhost:8000!
1. Create branch from the latest dev branch
`sh`
git checkout dev
git pull upstream dev
git checkout -b [_your_branch_name]
2. Make your changes
3. Make pull request
- Push your changes to your origin
`sh`
git push -u origin [_your_branch_name]
- Click on the autogenerated link from the terminal to open the PR
- Make sure to change the PR base to dev branch
- to get the dictionary.json file:
`sh`
npm run build-translation
- The language files /src/i18/{lang}.json files.dictionary.json
- The library uses the generated file.
- To deploy the /example folder:`
sh`
npm run deploy-example
- To deploy latest version embedded in binary-static (for testing)
`sh`
npm run deploy-hard
**NOTE: For the second time you are deploying, run the following command:
`sh`
npm run deploy-soft
1. Run:
`sh`
npm install
2. Update the files dist/webtrader-charts.js and dist/webtrader-charts.iife.js
`sh `
npm run build
3. Update the package version in package.json
4. Commit the modified files and merge them into the repo
5. Run:
`sh ``
npm publish