fluffycatware/kittycoin-club

<img src="https://raw.github.com/fluffycatware/kittycoin-club/master/img/project-banner.png" data-canonical-src="https://raw.github.com/fluffycatware/kittycoin-club/master/img/project-banner.png" align="center"/>

<div align = "center">
    <h1>KittyCoin Club <em>DApp</em></h1>
    <p>Donation site for cats in foster care built on smart contracts.</p>
    <a href="https://travis-ci.org/fluffycatware/kittycoin-club" target="_blank"><img src="https://travis-ci.org/fluffycatware/kittycoin-club.svg?branch=master" alt="Build Status"></a>
    <a href='https://coveralls.io/github/fluffycatware/kittycoin-club'><img src='https://coveralls.io/repos/github/fluffycatware/kittycoin-club/badge.svg' alt='Coverage Status' /></a>
    <a href="https://www.ethereum.org/" target="_blank"><img src="https://img.shields.io/badge/Ethereum-ETH-blue.svg" alt="Ethereum"></a>
    <a href="https://solidity.readthedocs.io" target="_blank"><img src="https://img.shields.io/badge/Solidity-%5E0.4.18-blue.svg" alt="Solidity"></a>
    <a href="https://nodejs.org/" target="_blank"><img src="https://img.shields.io/badge/Node.js-%5E9.2.0-blue.svg" alt="Node.js"></a>
    <a href="https://snyk.io/test/github/fluffycatware/kittycoin-club.git" target="_blank"><img src="https://snyk.io/test/github/fluffycatware/kittycoin-club.git/badge.svg" alt="snyk.io"></a>
    <a href="https://codeclimate.com/github/fluffycatware/kittycoin-club/maintainability"><img src="https://api.codeclimate.com/v1/badges/8637d69c2bd4bf1702a6/maintainability" /></a>
</div>

## About

This repository houses the [kittycoin.club](https://kittycoin.club)'s donation system. It has been built using Ethereum smart contracts.

## Contract Design

<img src="https://raw.github.com/fluffycatware/kittycoin-club/master/img/KittyCoinClub-design.png" data-canonical-src="https://raw.github.com/fluffycatware/kittycoin-club/master/img/KittyCoinClub-design.png" align="center"/>

## Developing This Contract

In order to develop this contract the following steps were taken to setup the environment.

Install and run Ganache CLI (formally you would have used TestRPC). Alternatively you can install [Ganche](http://truffleframework.com/ganache/) UI.

```
$ npm install -g ganache-cli
$ ganache-cli
```

When you run Ganache you'll be presented with 10 accounts with private keys. The RPC service that you can interact with the blockchain through is also available on `localhost:8545` for the CLI version and `localhost:7545` for the GUI.

Navigate into the root of this project and install truffle (if you haven't already got it). Run the truffle test command to compile and test the contracts.

```bash
npm install -g truffle
npm run test
```

If you watch the `ganache-cli` output you'll see various transactions taking place while your the contracts unit tests are executed.

Here's and example of a transaction:

```bash
Listening on localhost:8545
net_version
eth_accounts
eth_accounts
eth_accounts
net_version
net_version
eth_sendTransaction

  Transaction: 0x0c53488c3db64d41f972dfa9ce4d96f123f404f2a72fc7e843e5c8265b34c8ee
  Contract created: 0x926f5105ea9e1cbf4476a5437e42c5880b78309a
  Gas usage: 269607
  Block Number: 1
  Block Time: Wed Jan 17 2018 22:42:34 GMT+0800 (AWST)
```

When `npm run test` is executed it uses the config within the `truffle-config.js` file. This runs the test against a network run with `lite-server` and `testrpc` (this method is not longer the defacto way of working, however its easier for us to deploy and use with travis.ci).

The configuration for running the network locally using truffle is in the `truffle.js` file with the configuration below.

```javascript
    test: {
        host: "localhost",
        gasPrice: 1,
        gas: 0xffffffff,
        port: 7545,
        network_id: "*", // Match any network id
    },
```

*Note: I have 7545 in this file as I've been using the GUI version of Ganache which defaults to this port.*

When you are ready to test, run the `ganache-cli` or `ganache gui` client and then execute the following to compile and deploy the contracts to the network

```bash
truffle compile
truffle migrate
```

then to run the dev application use the following

```bash
npm install
npm run dev
```

### Send yourself some ETH

You can use the `truffle console` to send yourself some ETH to use. Replace your address with the one in the `to:` field

```bash
$ truffle console

truffle(development)> web3.eth.sendTransaction({from:web3.eth.accounts[0], to:'0xb39274C9887d314Ba65dA9929f3d0E94893570A7', value: web3.toWei(20, "ether")})
```

## Screenshots

<img src="https://raw.github.com/fluffycatware/kittycoin-club/master/img/project-dashboard.png" data-canonical-src="https://raw.github.com/fluffycatware/kittycoin-club/master/img/project-dashboard.png" align="center"/>

## Attribution

This smart contract used [Giveth's Base layer](https://github.com/Giveth/common-contract-deps) contract structure. Check out the amazing work they are doing at [Giveth's website](https://github.com/Giveth/website).

`Ownable.sol` contract is provided by the [zeppelin-solidity](https://github.com/OpenZeppelin/zeppelin-solidity) repo.