3D-e-Chem / molviewer-tsx

Visualize protein with it's natural ligand and candidates
Apache License 2.0
2 stars 1 forks source link

Web application to visualize proteins, ligands and pharmacophores. Web application is used in Molviewer KNIME nodes.

Build Status SonarCloud Gate SonarCloud Coverage

This project was bootstrapped with Create React App using scripts package @nlesc/react-scripts.

Dependencies

Installation

yarn install

Development setup

Development needs to be done together with Molviewer KNIME nodes. The KNIME nodes will use the MolViewer global variable to render one of the app classes.

Editing

Use Visual Studio Code v1.5 or later. When editing *.tsx files use Typescript inside the repo and not the Typescript shipped with VSCode.

Unit test

yarn test

To also get coverage run

yarn test -- --coverage --no-cache -w 1

The coverage reports will be written to coverage/remapped directory.

Format

yarn prettier

Will format files in src/.

See https://github.com/prettier/prettier how to setup your editor.

Linting

yarn lint

Enable tslinting inside Visual Studio Code with

  1. Open the command palette CRTL + P
  2. Run ext install tslint

Deploy

First build with:

yarn build

Then copy essential build files to the knime-molviewer repo:

./deploy.sh