/candy-machine-v2-responsive-ui

Solana Candy Machine V2 with a Prod-ready and easy to customize responsive UI.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Introduction

PROD-READY Candy Machine Responsive UI which can be easily customized in 5mn.

UP-TO-DATE with latest Metaplex improvements

All Candy Machine V2 functionalities are implemented, auto detected and maintained up-to-date :

  • public mint (with countdown when date in future)
  • civic support (gatekeeper)
  • whitelist
  • presale true/false
  • end date / end number (endSettings)
  • spl-token to mint
  • latest MCC updates from Metaplex

Candy Machine Preview Image

Supported Wallets

Supported Wallets

For instructions on how to set up a V2 candy machine, please refer to Metaplex's documentation here

One-Click Vercel Deployment

One-click solution to clone this project to your GitHub and deploy the prod package on a Vercel. Your only task will be to customize your GitHub fork of this project and commit updates. Vercel will automatically deploy new prod packages for each new commit.

Deploy with Vercel

To thank me with a small SOL tip :]

58SevvhmaN4SfCop2HkepAWyM5zykr7Afiv91PAAfPqR

Getting Set Up

Prerequisites

If not already done, make sure to have a working candy machine setuped. You can learn all about that watching that awesome and very complete tutorial : https://www.youtube.com/watch?v=9dAnpo0OiAg

REQUIRE NODEJS VERSION <= 16 (version 17 not supported).

  • Download a Code Editor such as Visual Studio Code.

  • Ensure you have both nodejs and yarn installed. nodejs recommended version is 16.

  • Follow the instructions here to install the Solana Command Line Toolkit.

  • Follow the instructions here to install the Metaplex Command Line Utility.

    • Installing the Command Line Package is currently an advanced task that will be simplified eventually.

Installation

1. Fork the project & clone it. Example:

git clone https://github.com/Fulgurus/candy-machine-v2-responsive-ui.git

2. Define your environment variables (.env file)

Rename the .env.example file at the root directory to .env and update the following variables in the .env file:

REACT_APP_CANDY_MACHINE_ID=__PLACEHOLDER__

set PLACEHOLDER with the candy machine pubkey you get once you upload & create your candy machine in Metaplex project. You can find back the value from the .cache/temp.json file of your Metaplex project. This file is created when you run the ts-node candy-machine-v2-cli.ts upload ... command.

REACT_APP_SOLANA_NETWORK=devnet

This identifies the Solana network you want to connect to. Options are devnet, testnet, and mainnet.

REACT_APP_SOLANA_RPC_HOST=https://api.devnet.solana.com

This identifies the RPC server your web app will access the Solana network through.

If you are using a custom SPL Token to MINT, you have two additional environment parameters to set :

REACT_APP_SPL_TOKEN_TO_MINT_NAME=

Spl-token name to display next the price.

REACT_APP_SPL_TOKEN_TO_MINT_DECIMALS=9

Spl-token decimals were defined during its creation with --decimals parameter. If you didn't use that parameter, then by default your SPL Token got 9 decimals.

More info about it there : https://spl.solana.com/token

3. Build the project and test. Go to the root project directory and type the commands :

To install dependencies :

yarn install

To test the app locally in the development mode (localhost:3000) :

yarn start

To build the production package (generated in build folder of the project) :

yarn build

4. Customize the website UI :

4.1 App.css : update 5 main CSS variables with your custom colors :
:root {
  --main-background-color: #343A50;
  --card-background-color: #804980;
  --countdown-background-color: #433765;
  --main-text-color:#F7F6F4;
  --title-text-color:#3CBA8B;
}

Next to that, make sure to update background image by overwriting your own background PNG file in src/img folder.

4.2 public folder :
  • Update existing demo cool cats images (cool-cats.gif, logo.png) with your owns images in project public folder. Make sure to name them identically.
  • Add your custom website title in index.html : <title>Mint Page</title>
4.3 Home.tsx :

Scroll down down to line 380 (return <main> [...]) and start to update all titles/menu/text/images/text... as wished in the whole React HTML block.

That's it ! Enjoy your beautiful candy machine :)

Available Commands Recap :

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

Need Help ?

You can ask for help in Stractors Discord : https://t.co/0VM0TkwiAn