Code Monkey home page Code Monkey logo

akropolis-mvp-v1.0's Introduction

Akropolis Pension Funds protocol

CircleCI Coverage Status

This demo project is a collection of smart contracts that implements business logic for running a pension fund on blockchain.

It is a legacy project that represents the 1.0 Iteration of the MVP

Overview

The Akropolis project is building the largest alternative pensions infrastructure in the world. We are creating decentralised pensions on the blockchain, built by and for the people, creating a safer financial future for humanity.

Installation

This project requires node-js runtime and uses truffle as the Ethereum smart contract development framework. You will need to have node installed first, in order to use the node package manager (npm). We also recommend installing yarn to effectively manage dependencies.

In order to run the project, install the truffle suite:

npm install -g truffle

Then install all of the node-js dependencies from within the git directory.

npm install

The connection to the blockchain node is defined in truffle.js, and as default is configured to be used locally:

module.exports = {
    networks: {
        development: {
            host: 'localhost',
            port: 8545,
            network_id: '*' // Match any network id
        }
    }
}

We recommend using popular Ethereum test client Ganache as a default local testing node:

npm install -g ganache-cli

Note: For Windows users, you may need to change the truffle.js filename in repository to truffle-config.js

Running tests

To run all of the smart contract tests, execute the testing script:

yarn test

Alternatively, you may also call the truffle command directly:

truffle test

Running service

This project uses gulp to serve files. Before calling gulp you can ensure truffle files are compiled if they haven't been already

truffle compile

Install gulp via command

sudo npm install --global gulp

Npm Modules of course are installed via

npm install

You can run the service using

gulp serve

Note that the output will be by default on port :8080 and index.html page-> e.g. localhost:8080/index.html

You can use the following to inject a secret string in the URL so that it is distinct

gulp serve:dist

License

MIT License

Copyright (c) 2018 Akropolis Decentralised Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

akropolis-mvp-v1.0's People

Contributors

jakub-wojciechowski avatar onigiri-x avatar piotrppe avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.