GitXplorerGitXplorer
r

Crypto-Crowdfund

public
34 stars
12 forks
0 issues

Commits

List of commits on branch main.
Unverified
a2de0ca91ca00f9d3cd846a98e404cebba241dcb

chore: updated readme

rruppysuppy committed 3 years ago
Unverified
5ddb5152b9cf395dd886c7d132c63f392b9692ea

chore(gitignore): added build + deployment file to ignore

rruppysuppy committed 3 years ago
Unverified
a43bca3c7593fe7cc2809353858ce5dba342be25

feat(script): added build script

rruppysuppy committed 3 years ago
Unverified
a0f80e8ffa4e8ce2898838bbc7b52ae973a334d6

feat(webpack): finalized production config

rruppysuppy committed 3 years ago
Unverified
64e9e2b12b54a7055a37669cba93bd5d1fa0b1a7

fix(blockchain): made campaign page mobile responsive

rruppysuppy committed 3 years ago
Unverified
dbf4ff991bba0c99792d85e1eca2c190dee1c2ab

chore(blockchain): minor ui tweaks

rruppysuppy committed 3 years ago

README

The README file for this repository.

Crypto Crowdfund

For Creators

Lacking the money to bring your Creative Venture to Life?

Crypto Crowdfund Campaigns will help you turn your creative ideas into reality! It's where creators share new visions for creative work with the communities that will come together to fund them.

No matter what, creators always control how the work comes together: no 100-page grant applications, no donors demanding you modify your message, no last-minute edits from investors. When backers chip in funding and help spread the word, they too become part of these independent works.

For Investors

Worried about being Conned by Fake Campaigns?

Crypto Crowdfund brings power to the Investors as well! Backed by the razor-edge security of BlockChain Technology, only after the majority of the investors have approved a Transaction Request, the transaction can be processed.

No more being scammed by Fake Campaigns!

For Scalability

Made to Last

Crypto Crowdfund is powered by the cutting edge technology of Micro-Frontends, making developing scalable issues a thing of the past.

Each sub-application in Crypto Crowdfund is developed and run as a separate instance. So a bug in one part of the application cannot affect the other parts.

Firebase Setup

Follow the instructions below to setup Firebase

  1. Create a Firebase project

  2. Add Authentication to the project & enable Email Authentication

  3. Add Firestore to the project & secure the database using these rules:

    rules_version = '2';
    service cloud.firestore {
       match /databases/{database}/documents {
          match /campaigns/{campaign} {
             allow read: if true;
             allow create: if request.auth != null;
             allow update: if request.auth != null && request.auth.uid == resource.data.uid;
          }
          match /requests/{requestList} {
             allow read, create: if request.auth != null;
          }
          match /users/{user} {
             allow read, create: if true;
             allow update: if request.auth != null && request.auth.uid == resource.data.uid;
          }
       }
    }

Setup

The application uses yarn to run.

To set up the Smart Contract please check out the steps mentioned in the ReadMe under smart-contract. To run the Blockchain Sub-app, generating all files is mandatory

  1. Run the command yarn to install all dependencies

  2. Add .env files at the root of all Sub-apps and the Container with the following data:

    # firebase config
    API_KEY=<api_key>
    AUTH_DOMAIN=<auth_domain.firebaseapp.com>
    PROJECT_ID=<project_id>
    STORAGE_BUCKET=<storage_bucket.appspot.com>
    MESSAGING_SENDER_ID=<messaging_sender_id>
    APP_ID=<app_id>
    MEASUREMENT_ID=<measurement_id>

    Add .env.development file at the root of Blockchain Sub-app following data:

    # auth config
    TEST_AUTHENTICATE_EMAIL=<firebase_test_user_email>
    TEST_AUTHENTICATE_PASSWORD=<firebase_test_user_password>

    and also add the infura key in the .env file in the Blockchain Sub-app

    # ...
    # infura key
    INFURA_PROJECT_ID=<infura_project_id>
  3. Run the command yarn run-auth to run the Auth Sub-app

    Runs on http://localhost:8001. Valid routes: /sign-in, and /sign-up

  4. Run the command yarn run-marketing to run the Marketing Sub-app

    Runs on http://localhost:8002. Valid routes: /, /about, /faq, /terms-and-conditions, /privacy-policy, and /disclaimer

  5. Run the command yarn run-blockchain to run the Blockchain Sub-app

    Runs on http://localhost:8003. Valid routes: /account?uid=<user_id>, /campaign?id=<campaign_id>, /campaigns and /create-campaign

  6. Run the command yarn run-container to run the Container

    Runs on http://localhost:3000. Compiles all Sub-Apps routes and determines when a user can visit them, eg: restricts authenticated users from visiting /sign-in, and /sign-up

NOTE: The application is hard-coded to run on Rinkeby Network. To use the application on other networks, please switch to the desired network in the web3.ts and deploy.js files.

Building the Application

  • Build the Sub-Apps using yarn build (inside each Sub-Apps Directory)

  • Deploy all Sub-Apps to any provider of choice

  • Create packages/container/webpack/urls.json with the deployed urls

    {
      "auth": "<deployed-auth-subapp-url>",
      "marketing": "<deployed-marketing-subapp-url>",
      "blockchain": "<deployed-blockchain-subapp-url>"
    }
  • Build the Container using yarn build (inside the Container Directory)

  • Deploy the Container to any provider of choice