Orange Fund is a crowdfunding/fundraising platform that allows projects to raise native Bitcoin (BTC)
In order to deploy an instance of OrangeFund, you can follow these steps:
- Run
npm iin theweb/folder - Set up a SQL database and run the following commands in the
webfolder
npx db pushto create and push updates to your SQL db according toschema.prismanpx prisma generateto update your schema definitions in prismanpx prisma studioto run a UI to browse your DB
- Set up an Electrum server to track Bitcoin deposits through your own xpub (extended public address) and set of private keys
- Use
npm run startto run the Next.js server locally
Don't forget to set your environment variables in the .env file (see .env.example for an example).
Additionally, you can deploy an instance of Orange Fund to Vercel (https://vercel.app/)
Current supported features:
- Create a project to raise BTC on a wallet with your own set of private keys
- Host an Electrum Server instance to support any Bitcoin wallet (whether it's a CEX withdrawal or a person's private wallet)
- Keep track of each funding event through on-chain governance on Stacks
- Upload rich media (jpeg, png, mp4, ...) to showcase the uniqueness of your project
IMPORTANT: OrangeFund has not been audited by any external firm as of today.
Install Clarinet: https://github.com/hirosystems/clarinet
OrangeFund is partly written in Clarity and therefore requires you to install Clarinet locally on the command line. Type the following command to check that you have Clarinet installed:
$ clarinet --versionPlease make sure you have Clarinet version 0.31.1 or higher installed.
- Clone the repo:
$ git clone [email protected]:Trust-Machines/bitcoin-funding.git && cd bitcoin-funding- Run the unit test to confirm all the tests passed and everything is working:
$ clarinet test- Open the Clarinet console in order to interact with the contract
$ clarinet console