Skip to content

decentralized-nation/crowdfund

Repository files navigation

CrowdFund

An Ethereum based Crowd Funding Platform for the Entrepreneurs 🔥

Getting Started

Getting started with the CrowdFund is easy.

First clone the project.

git clone https://github.com/decentralized-nation/crowdfund

Now head over to our issue board and help solving 👼

Prerequisites

CrowdFund uses Solidity to logic the smart contracts.

Configurations

We use a Single Run Compilation script to compile the solc code.

const path = require('path');
const solc = require('solc');
const fs = require('fs-extra');

const buildPath = path.resolve(__dirname, 'build');
fs.removeSync(buildPath);

const campaignPath = path.resolve(__dirname, 'contracts', 'Campaign.sol');
const source = fs.readFileSync(campaignPath, 'utf8');
const output = solc.compile(source, 1).contracts;

fs.ensureDirSync(buildPath);

for (let contract in output) {
    fs.outputJsonSync(
        path.resolve(buildPath, contract.replace(':', '') + '.json'),
        output[contract]
    );
}

Running the tests

Mocha is our friendly 😊 test framework used for testing.

To run the test use the following commant.

npm run test

Deployment

Under documentation.

Built With

  • Solidity - The lang of smart contratcs.
  • React - The Client side framework used.
  • Infura - Used to deploy the contracts to networks.

Contributing

Please read CODE_OF_CONDUCT.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments