theupscale/finocial

Finocial

Finocial Protocol has been created to provide a secure, flexible, open source foundation for decentralized loan marketplace on the *** *** (as of now). We provide the pieces necessary to create a decentralized lending exchange, including the requisite lending assets, clearing and collateral pool infrastructure, enabling third parties to build applications for lending.

Join our *** community to interact with members of our dev staff and other contributors.

Dependencies

This project uses Node.js version 8.10.0 - 8.11.3.

If you are running multiple versions of Node.js, *** using Node Version Manager (nvm). nvm is an easy way to configure and manage different Node.js versions to work with your projects.

Getting Started?

A Makefile is provided for easy setup of the environment.

Some pre-requisites are required in order to utilize the Makefile.

git clone https://github.com/upscaletech/finocial.eth.git # clone this repository

From here you will be able to use make commands assuming npm is already installed.

Assuming you have npm already, Install truffle

make install truffle

make install_deps

Tests

Start truffle and its development *** with

make start_console

Run the example migrations as well as the accompanying tests inside the truffle console

truffle(develop)> migrate --reset
truffle(develop)> test

Running tests with coverage enabled

The most convenient way to run tests with coverage enabled is to run them with help of Docker orchestration. This ensures, that the coverage results will match the ones on Travis CI.

We are working on it.

Contribution

Want to hack on Finocial Protocol? Awesome!

Finocial Protocol is an Open Source 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.

Ready to jump in? Check docs.finocial.com/#contributing.