A decentralized crowdfunding application. Built on the Stacks blockchain + NextJS.
Local development requires Node.js, Docker, and Clarinet.
npm i
npm test:contracts
This application uses Vercel Postgres. The database schema is found in db-tables.sql.
To run locally, connect to the existing Vercel project (or, if you forked the repo, create your own project in Vercel from this repo, enable Vercel Postgres, and create the necessary tables using the contents of db-tables.sql).
Then, run:
vercel env pull .env.development.local
You should see a new file .env.development.local, which provides credentials for your local app to connect to the database.
If you want to run the application with the deployed contracts on Testnet/Mainnet, set the environment variable NEXT_PUBLIC_STACKS_TESTNET or NEXT_PUBLIC_STACKS_MAINNET to true.
If you want to run a local Stacks Devnet, run:
clarinet devnet start
This will start a Stacks Devnet at localhost:3999. The terminal window will turn into an interface where you can browse mined blocks and the transactions within them. The DevNet will automatically deploy the campaign-funding smart contract, and make several local wallets available for testing (see settings/Devnet.toml for details).
If you make changes to the Smart Contract during development, you will need to stop and restart the DevNet.
Once the DevNet is running, note that you can use the Stacks Explorer connected to your DevNet to easily call functions, browse blocks, and request STX from the faucet to use for testing.
Finally, you'll need to provide values for these environment variables in your .env.development.local file:
NEXT_PUBLIC_APP_STX_ADDRESS: STX wallet address for a wallet responsible for making contract calls.
In a separate terminal window, run:
npm run dev
This will start the NextJS application at localhost:3000.
Visit localhost:3000 in your browser.
- If you restart your Stacks DevNet, you should also delete all rows from the database to avoid unexpected app behavior.
- To test the app, you'll need tokens in your wallet. You can request tokens from the faucet for Testnet and Devnet.
Contract code can be found within the contracts directory.
Public functions
add-campaign: create a new campaign.update-campaign-data: update data for a given campaign.contribute-to-campaign: make a contribution to a given campaign. the funds are collected from the caller's wallet and stored in the contract, awaiting the end of the campaign.fund-campaign: sends funds raised to the campaign owner. can be called exactly once, after a campaign has reached its end, and if the campaign has met its funding goal.refund-contribution: refunds a contribution back to a contributor. can be called exactly once per contributor, after a campaign has reached its end, and if the campaign did not meet its funding goal.
Read-only functions
get-campaign: get details of a given campaignget-campaign-funding-totals: get the total amount raised and total number of contributions to a given campaignis-campaign-expired: check if a campaign has reached its endget-contribution-info: get info about a given contributor's contribution to a given campaign
GET /api/campaigns: get all campaigns and their funding infoPOST /api/campaigns: save a newly created campaign (the campaign is first created directly on-chain by the client via the user's STX wallet)PUT /api/campaigns/{id}: save updates to a campaign (the campaign is first updated directly on-chain by the client via the user's STX wallet)GET /api/campaigns/{id}: get campaign detailsPOST /api/contributions: save info about a contribution made to a campaign (the contribution is first sent directly on-chain by the client via the user's STX wallet)PUT /api/campaigns/close: closes any campaigns that have reached their end. either sends the collected funds to the campaign owner, or refunds the contributors, depending on if the campaign reached its funding goal.