|
1 |
| -Docs coming soon. |
2 |
| - |
3 |
| -In the meantime, you might find this helpful too: |
4 |
| -https://hackmd.io/@levicook/HJcDneEWF |
5 |
| - |
6 | 1 | # Candy-Machine-Mint
|
7 | 2 |
|
8 |
| -Exiled Apes' Candy-Machine-Mint project is designed to let users fork, customize, and deploy their own candy machine mint app to a custom domain, ultra fast. |
| 3 | +The Candy-Machine-Mint project is designed to let users fork, customize, and deploy their own candy machine mint app to a custom domain, ultra fast. |
9 | 4 |
|
10 | 5 | A candy machine is an on-chain Solana program (or smart contract) for managing fair mint. Fair mints:
|
11 | 6 | * Start and finish at the same time for everyone.
|
12 | 7 | * Won't accept your funds if they're out of NFTs to sell.
|
13 | 8 |
|
14 |
| -Exiled Apes' Candy-Machine-Mint project is meant to be as simple and usable as possible, accessible to everyone from long-time crypto devs to junior React devs with a vague interest in NFTs. Our goal is to empower users to create their own front ends to display, sell, and manage their NFTs as simply as possible by just updating a few styled components and following a well-documented process for setup and shipping. |
| 9 | +The Candy-Machine-Mint project is meant to be as simple and usable as possible, accessible to everyone from long-time crypto devs to junior React devs with a vague interest in NFTs. Our goal is to empower users to create their own front ends to display, sell, and manage their NFTs as simply as possible by just updating a few styled components and following a well-documented process for setup and shipping. |
15 | 10 |
|
16 | 11 | ## Getting Set Up
|
17 | 12 |
|
18 | 13 | ### Prerequisites
|
19 | 14 |
|
20 |
| -* Follow the instructions [here](https://docs.solana.com/cli/install-solana-cli-tools) to install the Solana Command Line Toolkit. |
21 | 15 | * Ensure you have recent versions of both `node` and `yarn` installed.
|
22 | 16 |
|
| 17 | +* Follow the instructions [here](https://docs.solana.com/cli/install-solana-cli-tools) to install the Solana Command Line Toolkit. |
| 18 | + |
| 19 | +* Follow the instructions [here](https://hackmd.io/@levicook/HJcDneEWF) to install the Metaplex Command Line Utility. |
| 20 | + * Installing the Command Line Package is currently an advanced task that will be simplified eventually. |
| 21 | + |
23 | 22 | ### Installation
|
24 | 23 |
|
25 |
| -## Environment Variables |
| 24 | +1. Fork the project, then clone down. Example: |
| 25 | +``` |
| 26 | +git clone [email protected]:exiled-apes/candy-machine-mint.git |
| 27 | +``` |
| 28 | + |
| 29 | +2. Build the project. Example: |
| 30 | +``` |
| 31 | +cd candy-machine-mint |
| 32 | +yarn install |
| 33 | +yarn build |
| 34 | +``` |
| 35 | + |
| 36 | +3. Define your environment variables using the instructions below, and start up the server with `npm start`. |
| 37 | + |
| 38 | +#### Environment Variables |
26 | 39 |
|
27 | 40 | To run the project, first create a `.env` file at the root directory and define the following variables:
|
28 | 41 |
|
|
0 commit comments