#
Getting Started
After installing at the necessary software (help link) we will set up an ApeworX project that contains a few tests, so a working installation of Apeworx and with some plugins is essencial.
To check if ApeworX is installed, in a terminal type:
ape
and you should see the following output
Usage: ape [OPTIONS] COMMAND [ARGS]...
Options:
-v, --verbosity LVL One of ERROR, WARNING, SUCCESS, INFO, or DEBUG
--version Show the version and exit.
--config Show configuration options (using `ape-config.yaml`)
-h, --help Show this message and exit.
Commands:
accounts Manage local accounts
cache Query from caching database
compile Compile select contract source files
console Load the console
init Initalize an ape project
networks Manage networks
plugins Manage ape plugins
run Run scripts from the `scripts/` folder
test Launches pytest and runs the tests for a project
Check the installed plugins:
ape plugins list
For this workshop, you will need the following:
Installed Plugins:
vyper 0.5.1
alchemy 0.6.1
polygon 0.5.1a1
Also, create a .env file in the root of your apeworx projet with the alchemy api key:
export WEB3_ALCHEMY_API_KEY=<ALCHEMY_KEY>
export PASS=<ACCOUNT PASSWORD>
To test if your ape installation is correctly set up with the polygon and alchemy plugins and the alchemy api key in environment variable, start a console connected to Polygon Mumbai through the alchemy provider:
ape console --network polygon:mumbai:alchemy