xiaods / inventory-manager

The inventory manager is a server implementation for community currency issuers

Inventory Manager

The inventory manager is an osseus based server implementation for community currency issuers.

It provides blockchain reflection of offchain activities on community currencies issued against the CLN.

Dependencies

To make sure that the following instructions work, please install the following dependencies on you machine:

• Node.js (comes with a bundled npm)
• Git
• MongoDB

Installation

To get the source of inventory-manager, clone the git repository via:

$ git clone https://github.com/ColuLocalNetwork/inventory-manager

This will clone the complete source to your local machine.

Navigate to the project folder and install all needed dependencies via npm:

$ npm install

This commands installs everything which is required for building and testing the project.

Developing

Run locally: npm run dev

This task will run the application and start listening on port 8080.

Under the hood, we use a complete osseus stack.

You will find the local configuration at LOCAL.js.

Configuration

See tutorial.

Getting Started

See tutorial.

Notifications

See tutorial.

Testing

Source linting

npm run lint performs a lint for all source code using standard js.

Unit testing

npm test executes (as you might think) the unit tests, which are located in test.

Enable a lot of transactions test

Before running npm test you should:

$ export A_LOT_OF_TXS={n}

Notes

• {n} is number of transactions to test
• There's a 1 second delay between each blockchain transaction so be patient :)

The task uses truffle framework.

Contributing

Please see contributing guidelines.

License

Code released under the MIT License.