Giter VIP home page Giter VIP logo

cilantro-js's Introduction

cilantro-js

Introduction

Cilantro-JS is a library which implements the underlying Cilantro protocol in javascript to allow for the local and secure serialization of contract transactions to be submitted to the cilantro network.

Install Dependencies

apt install node-typescript

apt install mocha

install node and npm:

npm v5.6.0

node v8.10.0

npm install

Build

After cloning the repository you will need to run the below commands to build the underlying typescript into usable javascript

gulp setup

This will create the build directory in the root of cilantro-js. Inside this directory there are 3 sub-directories:

bundle/
js/
ts/

The ts directory contains all of the typescript files brought together into a single directory for transpiling, the js directory contains all the transpiled files from the ts directory, and the bundle directory contains a single bundle.js file to be used for web applications.

gulp transpile

This will transpile the contents of build/ts into like-for-like files in build/js.

gulp bundlejs

This will take the contents of build/js alongside all npm dependencies and generate a monolithic bundle under build/bundle for distribution as a generic javascript library.

Test

Following a successful build, the test endpoints can be run against the generated Javascript library:

make test

This will run the suite of unit tests against the built code (note, make build is a prerequisite of the tests running) to ensure its integrity. If for some reason your local tests are not passing after a successful build, please feel free to open a ticket here.

cilantro-js's People

Contributors

cmcgrath13 avatar jeffwscott avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.