Skip to content

PhysisVerse/candy-machine-v3-ui

 
 

Repository files navigation

Candy Machine v3 UI Introduction

Hi! This is a production ready Candy Machine V3 responsive UI which can be easily customized. Major features of the CMv3 such as Candy Guards are implemented & auto-detected.

IMPORTANT: Use of Sugar CLI with this UI

To deploy a Candy Machine using Sugar, be sure to use the version that creates account version v1 Candy Machines. The latest sugar version as of updating this readME (29/04/2023) that supports account version 1 CMs, and this UI is sugar v2.0.0-beta.2.

Will look into adding functionality for CMv3 Account version v2 (which supports pNFT, royalty enforcement).

Preview

Desktop preview of Candy Machine V3 — Desktop preview.

Preview it live here.

Deploy with Vercel (recommended)

Vercel is great to host your Candy Machine on, deploy it instantly by clicking the button below.

Deploy with Vercel

Implemented features

  • Responsive UI
  • Single Mint UI
  • Multi Mint UI
  • Start Time Countdown
  • Preview Minted NFTs
  • Guards Supported
    • Start Date
    • End Date
    • Sol Payment
    • Token Payment
    • Mint Limit
    • Bot Tax
    • Token Burn
    • Token Gate
    • NFT Payment
    • NFT Burn
    • NFT Gate
    • Redeemed Amount
    • Address Gate
    • Allow List
    • Gatekeeper

Multi Group

For Multi-group functionality use multi-group branch

Desktop preview of Multi Group Functionality — Desktop preview of multi group functionality.

(PS: For optimal use, limit active/ongoing groups to 1 - button will be added automatically for each active group)

Env Variables

NEXT_PUBLIC_SOLANA_NETWORK=mainnet/devnet
NEXT_PUBLIC_RPC_HOST=networkURL
NEXT_PUBLIC_CANDY_MACHINE_ID=candyMachineID
optional: NEXT_PUBLIC_COLLECTION_IMAGE_URL=https://linktoyourcollectionimage.zyx
If left blank or undefined it will default to the example image
optional: NEXT_PUBLIC_COLLECTION_TITLE='Your Collection title'
If left blank or undefined it will default to the example title
optional: NEXT_PUBLIC_COLLECTION_DESCRIPTION='Your Description for the Collection.'
If left blank or undefined it will default to the example description
optional: NEXT_PUBLIC_TOKEN_TYPE='If needed, your accepted SPL token label, like e.g. USDC'
If left blank or undefined it will default to "Token"
optional: NEXT_PUBLIC_WEBSITE_URL=https://linktoyourwebsite.com
If left blank or undefined it will default to "#"
optional: NEXT_PUBLIC_TWITTER_URL=https://twitter.com/yourproject
If left blank or undefined it will default to "#"
optional: NEXT_PUBLIC_DISCORD_URL=https://discord.com/yourdiscordserver
If left blank or undefined it will default to "#"

If on Vercel or a similar host you need to add these as environmental variables in your project settings.

Quick customization

Want to customize the color scheme? This frontend uses 6 main colors that can be found in globals.css change these values and the changes will apply globally.

:root {
  --main-background-color: #0E0E0E;
  --alt-background-color: #202020;
  --white: #fff;
  --black: #000;
  --primary: #4E44CE;
  --error: #D92D20;
}

Preview alternative Candy Machine states

Candy Machine V3 with Start Date — Candy Machine V3 with Start Date

Candy Machine V3 with Address Gate, Allow List or other similar guards — Candy Machine V3 with Address Gate, Allow List or other similar guards

Collaborating

Want to collaborate and make the repo better? Feel free to submit a pull request to the main branch.

Feedback/Support

If you have any feedback or need support, please submit an issue through Github Issues.

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 94.8%
  • CSS 5.0%
  • JavaScript 0.2%