Create AAVE App

Create Ethereum-powered React app with one command, extended for interacting with and building on the AAVE protocol.

This project is an extension is an of the create-eth-app library created by @paulrberg.

Create AAVE App works on macOS, Windows, and Linux. If something doesn’t work, please file an issue.

Quick Overview

yarn create aave-app my-aave-app
cd my-aave-app
yarn react-app:start

Then open http://localhost:3000/ to see your app. When you’re ready to deploy to production, create a minified bundle with yarn run react-app:build.

Creating an App

You’ll need to have Node 8.16.0 or Node 10.16.0 or later version on your local development machine (but it’s not required on the server). You can use nvm (macOS/Linux) or nvm-windows to switch Node versions between different projects.

You'll also need Yarn on your local development machine. This is because Create AAVE App relies on Yarn Workspaces, a feature not supported by npm.

To create a new app, you may use the following method:

yarn create aave-app my-aave-app

yarn create <starter-kit-package> is available in Yarn 0.25+

It will create a directory called my-aave-app inside the current folder.

my-aave-app
├── README.md
├── node_modules
├── package.json
├── .gitignore
└── packages
    ├── contracts
    │   ├── README.json
    │   ├── package.json
    │   └── src
    │       ├── abis
    │       │   ├── erc20.json
    │       │   └── ownable.json
    │       ├── addresses.js
    │       └── index.js
    ├── react-app
    │   ├── README.md
    │   ├── package.json
    │   ├── node_modules
    │   ├── public
    │   │   ├── favicon.ico
    │   │   ├── index.html
    │   │   └── manifest.json
    │   └── src
    │       ├── App.css
    │       ├── App.js
    │       ├── App.test.js
    │       ├── ethereumLogo.svg
    │       ├── index.css
    │       ├── index.js
    │       ├── serviceWorker.js
    │       └── setupTests.js
    └── subgraph
        ├── README.md
        ├── abis
        │   └── erc20.json
        ├── package.json
        ├── schema.graphql
        ├── src
        │   └── mappings
        │       ├── tokens.ts
        │       └── transfers.ts
        └── subgraph.yaml

Once the installation is done, you can open your project folder:

cd my-aave-app

Philosophy

• Minimalistic by design: You are one command away from creating a new Ethereum-powered React app. No intermediary installs, scripts or shims.

• End-to-End: Create AAVE App provides you everything that you need to build and maintain an Ethereum-powered React app at scale, by bringing Yarn Workspaces, Create React App and The Graph under one roof

• Aimed at Experience Architects: As Kames CG argues in Ethereum Growth's Problem, the Ethereum ecosystem is in a much greater need for top-notch product creators, not smart contract developers. Create Eth App does not enable a smart contract development environment, expecting you to import your own ABIs or build on top of an established protocol like Maker, Compound or Sablier

• Not Reinventing The Wheel: Under the hood, you use Create React App, one of the most popular and battle-tested frontend development environments.

What’s Included?

Your environment will have everything you need to build a modern Ethereum-powered single-page React app:

• Smooth project management via Yarn Workspaces
• Everything included with Create React App: React, JSX, ES6, TypeScript and Flow syntax support
• Template subgraph that indexes the events emitted by an ERC-20 contract
• Minimalist structure for managing the smart contract ABIs and addresses
• Hassle-free updates for the above tools with a single dependency

Popular Alternatives

Create AAVE App is a great fit for:

• Learning how to write Ethereum-powered apps in a comfortable and feature-rich development environment.
• Starting new Ethereum-powered single-page React applications without wasting time on copy-pasting boilerplates
• Creating examples with React for your Ethereum-related libraries and components.

But Ethereum is a large ecosystem. Here are a few common cases where you might want to try something else:

• If you want to try Ethereum in its most basic form, consider using the Remix in-browser IDE
• If you want to write, test and deploy smart contracts, consider using Truffle, Dapp Tools or Etherlime
• If you want write smart contracts and also build a frontend app, consider using the Truffle React Box
• If you want to write smart contracts and keep the frontend app in the same repository but React isn't your cup of tea, consider using the Embark framework
• If you need to use a complex state container like Redux, consider using Drizzle

For alternatives to React in particular, read the official Create React App documentation.

Credits

This project exists thanks to all the people who contributed to the development of the create-eth-app library:

• @PaulRBerg
• @TomAFrench
• @KadenZipfel
• @rnbrady

Extended with AAVE-specific functionality by:

• @aschmidt20

Acknowledgements

We are grateful to the authors of existing related projects from which we drew inspiration:

• create-react-app
• create-next-app

And also the Vue.js community for the CLI we used to generate our templates:

• @vue/cli

License

Create AAVE App is open source software licensed as MIT.