Socket
Socket
Sign inDemoInstall

@binary-com/webtrader-charts

Package Overview
Dependencies
16
Maintainers
2
Versions
23
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @binary-com/webtrader-charts

webtrader charts


Version published
Weekly downloads
22
decreased by-77.32%
Maintainers
2
Created
Weekly downloads
 

Readme

Source

webtrader-charts

The charting library extracted from Webtrader is used for binary-static and webtrader.

Build Status

In this document:

Other Documents

Pre-installation

Before running or contribute to this project, you need to have the setup of the following packages in your environment

  • node
  • npm
  • git

Quick start

  1. Fork the project

    In order to work on your own version, please fork the project to your own repo.

  2. Clone using SSH

    git clone git@github.com:your-github-username/webtrader-charts.git
    
  3. Enter project directory

    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`
  1. 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`!

How to contribute

  1. Create branch from the latest dev branch

    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

    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

Manage translations

  • to get the dictionary.json file:

    npm run build-translation
    
  • The language files /src/i18/{lang}.json files.

  • The library uses the generated dictionary.json file.

Deploying to gh-pages

  • To deploy the /example folder:

    npm run deploy-example
    
  • To deploy latest version embedded in binary-static (for testing)

    npm run deploy-hard
    

    **NOTE: For the second time you are deploying, run the following command:

    npm run deploy-soft
    

Publishing to npm

  1. Run:

    npm install
    
  2. Update the files dist/webtrader-charts.js and dist/webtrader-charts.iife.js

    npm run build
    
  3. Update the package version in package.json

  4. Commit the modified files and merge them into the repo

  5. Run:

    npm publish
    

Keywords

FAQs

Last updated on 25 Apr 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc