The following tools are not required but highly recommended for a better coding experience:
- Terminal (Mac OS only): iTerm 2 (download)
- Shell: Oh my ZSH (download)
- Code Editor: VS Code (download)
- VS Code Plugins:
- Git of course :-)
- Node JS: Make sure to have Node JS installed.
- Infura: Create an Infura account and project and get the project id
- Etherscan: Create an Etherscan account and api key
- pyenv-virtualenv :
- Mac OS:
-
Install Homebrew (install)
-
Install package:
brew install pyenv-virtualenv
-
Add it to path (assuming you are using ZSH)
echo 'eval "$(pyenv init --path)"' >> ~/.zprofile
echo 'eval "$(pyenv init -)"' >> ~/.zshrc
echo 'eval "$(pyenv virtualenv-init -)"' >> ~/.zshrc
-
- Other OS: (Follow instructions to install)
- Mac OS:
-
Clone the repo
git clone git@github.com:hightop-web3/vyper-nft.git
and then:
cd vyper-nft
-
Install Ganache globally (Only needed once)
npm install -g ganache
-
Install python version
pyenv install 3.9.8
-
Create the Python virtual environment (Only needed once)
pyenv virtualenv 3.9.8 vyper-nft
-
Install the dependencies
pip install -r requirements.txt
- To Compile the smart-contracts, run:
brownie compile
- Run tests with:
brownie test
- When adding a new dependency run the command below to update the
requirements.txt
file.pip freeze > requirements.txt