react-ngl

[![Jobs][jobs-badge]][jobs-url]
[![npm][npm-badge]][npm-url]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]

React NGL

React wrapper for NGL


Explore the docs »




View Demo
·
Report Bug
·
Request Feature

About The Project

[![React NGL Screen Shot][product-screenshot]](https://github.com/gky360/react-ngl)

react-ngl is a React wrapper for NGL.

$3

- 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.

$3

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

- npm

``sh
npm install react-ngl
`

$3

1. Clone the repo

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

2. Install NPM packages

`sh
npm install
`

Usage

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

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

ReactDOM.render(


,
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`][license-url] for more information.

Contact

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

Acknowledgements

- nglviewer/ngl

[jobs-badge]: https://github.com/gky360/react-ngl/workflows/Jobs/badge.svg
[jobs-url]: https://github.com/gky360/react-ngl/actions
[npm-badge]: https://badge.fury.io/js/react-ngl.svg
[npm-url]: https://www.npmjs.com/package/react-ngl
[contributors-shield]: https://img.shields.io/github/contributors/gky360/react-ngl.svg
[contributors-url]: https://github.com/gky360/react-ngl/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/gky360/react-ngl.svg
[forks-url]: https://github.com/gky360/react-ngl/network/members
[stars-shield]: https://img.shields.io/github/stars/gky360/react-ngl.svg
[stars-url]: https://github.com/gky360/react-ngl/stargazers
[issues-shield]: https://img.shields.io/github/issues/gky360/react-ngl.svg
[issues-url]: https://github.com/gky360/react-ngl/issues
[license-shield]: https://img.shields.io/github/license/gky360/react-ngl.svg
[license-url]: https://github.com/gky360/react-ngl/blob/master/LICENSE.txt
[product-screenshot]: images/screenshot.png