README.md

neopt-sdk-js

neopt-sdk in JS

Instructions: make cpp_core_deps_js for build and very simple testing (Neo3CppLib will be placed on demo/dist/ folder)

To view demo/ on browser: make serve_demo (see localhost:9123).

It will use emscripten (it can be from docker), output will be on build folder (a .js and .wasm).

How to use

Install on browser

Under construction.

Practical Development Workflow

Under construction.

Run tests

make test (instead of npm test)

Build Webpack

make dist (instead of npm run build)

Increase minor version (typically)

npm version minor

Push and Publish (with new version)

git push origin master --tags

npm publish (requires npm login before)

Versioning Logic

We adopt semantic versioning, but plan to keep alpha 0.x for a long time... when community feels it is somewhat complete, we may plan some 1.0.

Demo

See demo folder for a working example (also on: https://neoresearch.io/neopt-sdk-js/demo/).

More Information:

• https://medium.com/neoresearch/a-hybrid-c-js-neo3-sdk-a1c3b799978

License

This project is released under MIT License.

The neo3-cpp-core dependencies are all built into a single library (binary) to be merged with this project (connected via .wasm).

NeoResearch 2020