Skip to content
This repository has been archived by the owner on Sep 21, 2022. It is now read-only.

koii-network/crowdfunding

Repository files navigation


Create Koii Fundraise 🐟 💰

typescript  cli version  made-by-koii 

⚡️ Quick start

First of all, run npx create-koii-fundraise to create a Koii Fundraise Portal.

After the installation is done head to the installed project and inside it run yarn start.

(If the yarn start doesn't work, please try react-scripts --openssl-legacy-provider start)

Table of Contents

Fundraiser Customization

To customize your fundraiser head to ./src/config/funding-config.tsx file in your app that you can change to match your portal config.

Example:

const config = {
  title: "Plagiarism Registry DAO", // Project title
  description: "Fighting plagiarism with a searchable, creator-owned world wide registry. Get rewarded for your work.", // Project description
  companyName: "Koii Network Creator Studio",
  fundGoal: 1000, // Your funding goal in "eth"
  images: [
    // Images to be placed in the top slider
    { src: "https://picsum.photos/700" },
    { src: "https://picsum.photos/701" },
    { src: "https://picsum.photos/702" },
    { src: "https://picsum.photos/703" },
    { src: "https://picsum.photos/704" },
    { src: "https://picsum.photos/705" }
  ],
  socials: {
    // Your social network links
    website: "https://koii.network",
    twitter: "https://twitter.com/KoiiNetwork",
    discord: "https://discord.com/invite/koii",
    facebook: null,
    github: "https://github.com/koii-network"
  },
  paymentType: "ar", // 'eth' or 'ar' Portal currency "eth" (ethereum) or "ar" (Arweave)
  fundAddress: "_JHZaUrLyOVSf_t87GBASHXziurNqXmxJ0VgYg-rggM", // Your funding address that people will deposit to. (Ethereum or Arweave address, depends on paymentType)
  // A brief description about the project as html.
  about: (
    <div>
      <p>About us</p>
    </div>
  ),

  faqs: [
    // FAQs content
    { question: "Question 1", answer: "Answer 1" },
    { question: "Question 2", answer: "Answer 2" },
    { question: "Question 3", answer: "Answer 3" }
  ]
};
export default config;

To change the logo of the fundraiser head to ./src/assets/ file in your app and replace the logo.png with your logo.

Deploy to Arweave

Few simple steps to deploy to your crowdfunding portal to Arweave:

  1. Install arkb globally on your machine. arkb runs using NodeJS and NPM. You must have both installed on your machine for it to work.
npm install -g arkb
  1. Put your Arweave wallet keyfile inside the root folder under as wallet.json

  2. Finally, Run:

 yarn deploy

To deploy to arweave 🎉

App Customization

Edit the ./src/config/app-config file to change the basic details about your app. e.g.

const config = {
  lang: "en", // language of your website
  locale: "en_US", // locale of your website
  title: "Koii Fundraiser DApp",
  description: "Create Koii Fundraiser",
  canonical: "https://crowdfunding-koii.vercel.app/", // Your production website link
  twitterHandle: "@KoiiNetwork", // Twitter username
  companyName: "Koii"
};

To change the favicon, head to public folder and replace the favicon.svg with yours.

Environment

Node

We recommend installing the latest LTS node version v16.13.1 to provides stable compatibility with React

  • Node v16.XX (node --version)

Or Download Node with NVM

Yarn

We install and run our scripts with yarn, as an alternative to npm:

Download Yarn

About

Crowdfunding Portal — Create Koii Fundraise

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages