This is a summary of setup-related tasks
Table of contents
- Commit messages
Private Key Generation
- Navigate to Vanity ETH to quickly create a
testnetEthereum key pair value.
- Scroll to the bottom, click
- Click to show and access the
- Copy both the public address and private key into the
"fundAccountEthAddress": "YOUR_ETHEREUM_ADDRESS", "fundAccountPrivateKey": "YOUR_PRIVATE_KEY"
Now either grab some ropsten test ether at the faucet or send yourself some from another account.
Note: it is heavily recommended to
NOT use this account for mainnet ether as the private key is stored unencrypted in a text file! For development purposes only!
- Navigate to Infura to create a new account or login with your existing account.
- If you're not already, navigate to your
- Create a new project (near the top mid of the webpage) and name it
- Save your
Project ID(aka API Key) this used in the
.secrets.jsonfile under the
- Whitelist the contract address specified in the
TLDR: just run the following script to set everything up in on go. For the longer annotated version see the step-by-step instructions below:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash . ~/.bashrc nvm install --lts curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add - echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list apt update && apt -y upgrade && apt -y install yarn apt install -y python-minimal apt install -y build-essential
The annotated version of the above script if you rather understand what you are doing:
- Install nvm:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash
- Refresh your
.bashrcfile which now got updated by the
Alternatively you could log out of your shell and open it again to have nvm set up. 3. Install the latest long-term support (LTS) version NodeJS:
nvm install --lts
- Make sure the latest LTS version got installed (currently v10.16.0)
- Install yarn:
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add - echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list apt update && apt -y upgrade && apt -y install yarn
- Install python2 (dependency for the node-gyp package that a dependency requires)
apt install -y python-minimal
- Install build-essential
apt install -y build-essential
The following Windows setup goes faster when one utilizes Chocolatey (a Windows Package Manager).
Required software packages:
- Node (using NVM to install and manage node versions)
- Windows Build Tools
- Visual Studio Code (recommended or your IDE of choice)
- solc (Solidity Compiler)
Open up PowerShell or cmd:
choco install git.install
choco install nvm
nvm install 11.3
nvm use 11.3
Verify node is working via:
Note: You may have to restart cmd/Powershell or refresh your environment (
refreshenv) in between the steps above.
Prepping Node 11.X
npm install --global windows-build-tools
npm install --global yarn
At this point,
yarn install should run successfully.
Follow the rest of the steps located in the README to run Hopr
We use emojjis to provide an easy visual representation of our commit types. Prepend every commit message with an emoji of this form:
<emoji> commit message. For commits with multiple types, use
<emoji><emoji2> commit message.
On OSX press
SPACE to show the emoji palette.
On Windows press
Which emoji to use?
|Initial commit||🎉 party popper|
|New feature||✨ sparkles|
|Bug fix||🐛 bug|
|Tests||🚨 police car's light|
|Refactoring||♻️ recycling symbol|
|Work in progress (WIP)||🚧 construction sign|
|Cosmetic change||🎨 artist palette|
|Breaking change||💣 bomb|
|Deprecation||💩 pile of poop|
|Version tag||🔖 bookmark|
|Internationalization||🌐 globe with meridians|