Whitelist_API

This repo is meant to be used with https://github.com/CryptoOutcasts/Candy_Machine_Whitelist_Site

after youre done with this repo and finalizing your API , you may proceed to Candy_Machine_Whitelist_Site

This project is only experimental, use carefully. Im not responsible for any fatal errors for any project. Always use on testnet before using on mainnet This project works offchain and does not validate whitelisted users using on chain data ! This repo is intended to be used with Candy Machine Mint site, or with my repo Candy_Machine_Whitelist_Site

How to run:

Clone the repo (obviously)

1) Add your own environmental variables (.env)

SECRET_KEY=__MY_KEY__

Your API authentication key used to prevent someone else from accessing the api and updating whitelisted users

after you are done rename ".env.sample" to ".env"

2) create a csv containing the list of whitelisted users and reserves for each user

REQUIREMENTS FOR CSV FILE:

Must be comma delimted
Must have two Columns: 1)member 2)reserve , Its important to name the two columns exactly like this

each row has a member which is the address of the user you wish to whitelist, reserve is how many nfts can they this address mint

Must be named whitelisted.csv
Must be in the main directory, do not put in a seperate file called assets or similar.

3) Edit the config.json to your needs

To reload the csv list everytime the script runs

set load_csv_onetime = false

If you wish to run the script once and not have it run everytime

```
set load_csv_one time = true
and loaded = false
```

4) Upload to a hosting server, we recommend heroku. if you decide to use heroku here are the steps to setting that up:

if you prefer tutorials, this one is good and features two options: https://www.youtube.com/watch?v=Rz886HkV1j4&t=733s

IMPORTANT: MAKE SURE TO FOLLOW THE STEPS FOR ADDING .ENV TO THE HOSTING SYSTEM (included in the video)

ALL COMMANDS SHOULD BE RAN IN THE MAIN DIRECTORY

Install the heroku CLI: https://devcenter.heroku.com/articles/heroku-cli

ITS IMPORTANT THAT YOU SAVE ALL THE FILES YOU EDITED INORDER FOR GIT TO RECOGNIZE CHANGES

run: heroku login , and then login into your account.
run git init
run heroku create Your_Project_Name heroku will then supply you with two urls, one of which is the url of the API, the other is not important (the one with github in it)
run git add .
run git commit -m "first-commit
run git branch -M master
run git push heroku master
after that is done run heroku config:set SECRET_KEY=Your_API_Key

Your_API_Key stands for the key you put in the env file in step 2

Congratulations 🍰, you have now deployed your API online.

to make sure everyting is working great:

Grab the heroku url, or the url you hosted your api on. and then add /whitelisted to it

https://myherokyapp.herokuapp.com/whitelisted

You should see a list of your whitelisted members that you included in the csv file great that means your api is working.

Grab the api key and heroku url and then integrate this with https://github.com/CryptoOutcasts/Candy_Machine_Whitelist_Site

If you need anything you can contact me on Crypto Outcasts discord server: https://discord.gg/KTVYs7QAfP

gabo1122 / whitelist_api Goto Github PK

whitelist_api's Introduction