operem
Operem
Last updated 2 years ago by jdutchak .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install operem 
SYNC missed versions from official npm registry.

Head to https://www.domain.com/developers to learn more about what we're building and how to get involved.

operem-js

operem-js is a library of javascript code and Ethereum smart contracts which allow anyone to create decentralized identities, including for fractional usage. It is an open source project created by Operem Protocol.

Documentation

operem-js documentation

Using operem-js in your project

As a node package

npm install <todo> --save

or

yarn add <todo>

Plain javascript

A browser-compatible plain javascript file operem.js is available in the Releases section. A hosted version can be directly included in your html as:

<script src="https://code.domain.com/operem-js/operem-v0.0.1.js"></script>

npm build will generate this file and save it to dist/operem.js.

Local development

1. Clone this repo.

git clone https://github.com/phOperem/operem-js.git && cd operem-js

If you would like to submit pull requests, you should instead fork this repo and then clone your fork. Note pull requests should always be made to the develop branch, which always has the latest commits.

2. Install dependencies and link

npm run install:dev

install:dev is shortcut for npm install && npm link. Linking means that changes to operem-js code are immediately available to local DApps without an npm install.

3. Start the local blockchain and build operem-js

npm start

Code changes will trigger a live rebuild.

Tests

Command Line (All Tests)

Our full test suite can be run with:

npm run test

Note: you should not have the server running at this time, as these tests start their own local blockchain instance.

Command Line (Only Solidity Tests)

Our Solidity tests (which use Truffle) are located at contracts/test.

npm run test:contracts

Note: you should not have the server running at this time, as these tests start their own local blockchain instance.

Browser Tests

A subset of our tests can be run from the browser. These tests are automatically served at http://localhost:8081 when you run npm start. These tests are automatically rerun when source or test code is changed.

Run a subset of these tests using the grep query string parameter, for example: http://localhost:8081/?grep=IpfsService

Using the Ganache GUI

By default, starting operem-js locally starts ganache-cli automatically. However, for development you might want to connect to the GUI version of Ganache. This provides a nice interface for browsing your local blockchain activity and can be useful for debugging.

To use the Ganache GUI:

  1. Install Ganache
  2. Start Ganache
  3. Navigate to the settings in Ganache (click on the gear in the upper right-hand corner)
  4. Set Port Number to 8545
  5. Set Network ID to 999
  6. Under the Accounts & Keys tab, set the mnemonic to candy maple cake sugar pudding cream honey rich smooth crumble sweet treat
  7. When starting operem-js locally, run npm run start:no-ganache (instead of npm run start)

Troubleshooting

Python 3

If you have Python 3 installed, you may see this error when installing dependencies:

gyp ERR! stack Error: Python executable "/Users/username/.pyenv/shims/python" is v3.6.4, which is not supported by gyp.

Resolve this by configuring npm to use Python 2 (where python2.7 is a binary accessible from your $PATH):

npm config set python python2.7

Contributing

Operem Identity is an open-source and community-driven project and we welcome contributions of all sorts. There are many ways to help, from reporting issues, contributing code, and helping us improve our community.

To get involved, please join our -todo-

Current Tags

  • 0.0.1                                ...           latest (2 years ago)

1 Versions

  • 0.0.1                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 0
Last Month 0
Dependencies (10)
Dev Dependencies (32)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |