Skip to content

Commit 1b83ef2

Browse files
authored
Merge pull request exiled-apes#19 from exiled-apes/readme-update
Readme update
2 parents 6763397 + ae6cc55 commit 1b83ef2

File tree

1 file changed

+35
-4
lines changed

1 file changed

+35
-4
lines changed

README.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,41 @@
1-
Docs coming soon.
1+
# Candy-Machine-Mint
22

3-
In the meantime, you might find this helpful too:
4-
https://hackmd.io/@levicook/HJcDneEWF
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.
54

5+
A candy machine is an on-chain Solana program (or smart contract) for managing fair mint. Fair mints:
6+
* Start and finish at the same time for everyone.
7+
* Won't accept your funds if they're out of NFTs to sell.
68

7-
## Environment Variables
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.
10+
11+
## Getting Set Up
12+
13+
### Prerequisites
14+
15+
* Ensure you have recent versions of both `node` and `yarn` installed.
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+
22+
### Installation
23+
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
839

940
To run the project, first create a `.env` file at the root directory and define the following variables:
1041

0 commit comments

Comments
 (0)