The first step to using Brownie is to initialize a new project. This can be done in two ways:
- Create an empty project using
brownie init
. - Create a project from an existing template using
brownie bake
.
To initialize an empty project, start by creating a new folder. From within that folder, type:
$ brownie init
An empty :ref:`project structure<structure>` is created within the folder.
You can initialize "Brownie mixes", simple templates to build your project upon. For many examples within the Brownie documentation we will use the token mix, which is a very basic ERC-20 implementation.
Mixes are automatically created within a subfolder of their name. To initialize the token
mix:
$ brownie bake token
This creates a new folder token/
and deploys the project inside it.
React-Mix is a bare-bones implementation of Create React App configured to work with Brownie. You can use it as a starting point for building your own React frontend for your dApp.
To initialize from this mix:
$ brownie bake react
See the React-Mix repo for more information on how to use React with Brownie.
Github-Actions-Mix is a template preconfigured for use with Github Actions continuous integration, as well as other useful tools.
To initialize from this mix:
$ brownie bake github-actions
See the Github-Actions-Mix repo for a detailed explanation of how to configure and use the tools within this template.