DaoCasino/bankroller-core

View on GitHub
README.md

Summary

Maintainability
Test Coverage
[![Maintainability](https://api.codeclimate.com/v1/badges/d48797878570cbc411ac/maintainability)](https://codeclimate.com/github/DaoCasino/bankroller-core/maintainability) [![npm_version](https://img.shields.io/npm/v/npm.svg)](https://www.npmjs.com/get-npm) [![nodejs version](https://img.shields.io/badge/nodejs-%3E=9.5-green.svg)](https://nodejs.org/en/download/current/) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

# Bankroller Core

This is the core code that powers the [Bankroller desktop application](https://github.com/DaoCasino/BankRollerApp) and the the bankroller command line tool.

## Install
bankroller-core is written in Javascript. Make sure you have Node.js (>= v9.5) installed, and your environment is capable of installing and compiling npm modules.

macOS Make sure you have the XCode Command Line Tools installed. These are needed in general to be able to compile most C based languages on your machine, as well as many npm modules.
```
npm i -S DaoCasino/bankroller-core
```

preinstall (on ubuntu)
```
curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash -
sudo apt-get install -y nodejs
sudo apt-get install -y build-essential
sudo apt-get install python2.7 git-all pkg-config libncurses5-dev libssl-dev libnss3-dev libexpat-dev
```
## Contribute

Feel free to dive in! [Open an issue](https://github.com/DaoCasino/bankroller-core/issues/new) or submit PRs.

We are follows the [Contributor Covenant](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) Code of Conduct.