Skip to content

Latest commit

 

History

History
150 lines (108 loc) · 5.5 KB

LOCAL_DEVELOPMENT.md

File metadata and controls

150 lines (108 loc) · 5.5 KB
Raw

Local Development

Command Reference

Make sure to follow the steps outlined in the rest of this file before using these commands.

Description Command Note
Start the local replica make start
Start the frontend server npm start
Build the canister make build
Build the frontend npm run build
Production frontend make fe
Production frontend local network NODE_ENV=production DFX_NETWORK=local make fe
Deploy the canister locally make local_deploy
Build the canister locally make dev_build
Set up and run e2e tests make e2e_test If you're using Ubuntu, it must be an LTS version.
Run e2e tests npm run test:e2e Assumes e2e setup is already done (see make e2e_test)

System Dependencies

First Time Setup

Clone the Taggr repo:

git clone [email protected]:TaggrNetwork/taggr.git

Change your directory to the newly cloned Taggr repo:

cd taggr

Install DFX

DFX_VERSION=$(cat dfx.json | jq -r .dfx) sh -ci "$(curl -fsSL https://internetcomputer.org/install.sh)"

The remaining steps are only necessary for deploying NNS canisters locally. This makes it easier to test new account creation with Internet Identity, to make ICP transfers to those accounts or to run Taggr e2e tests without a Docker container. Alternatively, you can create a backup and then refer to the command reference to build and deploy.

Create or edit ~/.config/dfx/networks.json, and add the following, note that dfx install requires port 8080 to work:

{
    "local": {
        "bind": "127.0.0.1:8080",
        "type": "ephemeral",
        "replica": {
            "subnet_type": "system"
        }
    }
}

Stop DFX if it's running:

dfx stop

Start DFX with a clean environment:

dfx start --clean --background

Install Taggr canister:

npm ci
make local_deploy
make dev_build
make local_reinstall

Install NNS canisters (see the DFX docs):

dfx extension install nns
dfx nns install

Now you are ready to create a new Taggr account with Internet Identity locally. If you also want to make ICP transfers to this account then continue with the remaining steps, the remaining steps are not necessary for running e2e tests.

Set up the private key for the local minting account:

cat <<EOF >~/.config/dfx/local-minter.pem
-----BEGIN EC PRIVATE KEY-----
MHQCAQEEICJxApEbuZznKFpV+VKACRK30i6+7u5Z13/DOl18cIC+oAcGBSuBBAAK
oUQDQgAEPas6Iag4TUx+Uop+3NhE6s3FlayFtbwdhRVjvOar0kPTfE/N8N6btRnd
74ly5xXEBNSXiENyxhEuzOZrIWMCNQ==
-----END EC PRIVATE KEY-----
EOF

Import the key into DFX:

dfx identity import local-minter ~/.config/dfx/local-minter.pem

Change to the new identity in DFX:

dfx identity use local-minter

At this point, you can refer to the command reference to deploy and run Taggr, create a new account and grab your account ID. Then you can transfer ICP to that account with this command:

dfx ledger transfer --memo 1000 --amount 10 ${accountId}

e2e Tests

Make sure to follow the first time setup instructions before running e2e tests without using the Dockerfile.

Run the test UI, this is great for watching the tests run as they are happening and checking screenshots at each stage:

npm run test:e2e -- --ui

To collect a static trace for tests:

npm run test:e2e -- --trace on

To help determine if tests are flaky, run them multiple times, note that only the file's name is required, not its full path. If the filename is omitted then all tests will be run multiple times:

npm run test:e2e -- ${test_filename}.spec.ts --trace on --repeat-each 10

During development, it can be common to write an incorrect selector or something else that will cause the test to timeout. If it's happening frequently and slowing down the feedback cycle then the max timeout can be set to a lower value. Be careful not to set it too low or you may get false negatives in the tests:

npm run test:e2e -- --timeout 10000