https://github.com/tobitsoftware/chayns-js

The chayns® JavaScript API allows you to expand your Site with many useful features.
https://github.com/tobitsoftware/chayns-js

chayns javascript javascript-library tobit

Last synced: 3 months ago
JSON representation

The chayns® JavaScript API allows you to expand your Site with many useful features.

• Host: GitHub
• URL: https://github.com/tobitsoftware/chayns-js
• Owner: TobitSoftware
• License: mit
• Created: 2017-03-22T10:21:46.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-10T10:18:32.000Z (over 1 year ago)
• Last Synced: 2024-04-14T06:09:50.870Z (over 1 year ago)
• Topics: chayns, javascript, javascript-library, tobit
• Language: JavaScript
• Homepage: https://github.com/TobitSoftware/chayns-js/wiki
• Size: 1.14 MB
• Stars: 19
• Watchers: 20
• Forks: 3
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![license](https://img.shields.io/github/license/TobitSoftware/chayns-js.svg)]() [![GitHub pull requests](https://img.shields.io/github/issues-pr/TobitSoftware/chayns-js.svg)]() [![](https://img.shields.io/github/issues-pr-closed-raw/TobitSoftware/chayns-js.svg)]()

# chayns® JavaScript API

In this section you will find general information about the chayns® JavaScript API. For more detailed information take a look at the [Wiki](https://github.com/TobitSoftware/chayns-js/wiki).

## Getting started

### Usage

If you want to use the chayns® JavaScript API in your own tapp, we suggest using the code below.

```HTML

```

Once the chayns API is implemented, you only need to run the chayns.ready-Promise. 


Watch [this](https://github.com/TobitSoftware/chayns-js/wiki/Getting-Started) getting started tutorial for more information on chayns.ready.

### Debugging

To work on the chayns JavaScript API, you need to install the dependencies:

``

npm i

``

Once the dependencies have been installed successfully, you can add your ssl certificate files in webpack/ssl.

If you don't have one, you need to remove the props `https`, `cert` and `key` from your dev config. 

To use chayns with a non-https tapp, you have to add the url parameter `nrd=1`.

Then, you can start the webpack-dev-server:

``

npm start

``

The dev page will be available at port 8080.