react-ngl

About The Project

react-ngl is a React wrapper for NGL.

Built With

• ngl >= v2.0.0-dev.37
• node >= 12.16.0
• react ^16.13.1

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

npm install react-ngl

Installation

1. Clone the repo

git clone https://github.com/gky360/react-ngl.git

2. Install NPM packages

npm install

Usage

A minimal example of using react-ngl is as follows.

import React from 'react';
import { Stage, Component } from 'react-ngl';

ReactDOM.render(
  <Stage width="600px" height="400px">
    <Component path="rcsb://4hhb" reprList={reprList} />
  </Stage>,
  document.getElementById('app')
);

For more examples, please refer to the Demo

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/gky360/react-ngl

Acknowledgements

• nglviewer/ngl