Aragon Buidler Boilerplate

🕵️ Find more boilerplates using GitHub | ✨ Official boilerplates

Buidler + React boilerplate for Aragon applications.

This boilerplate includes a fully working example app, complete with a background worker and a front-end in React (with Aragon UI).

Note: This is an experimental boilerplate for developing Aragon applications. For a more stable boilerplate, please use aragon-react-boilerplate.

Usage

To setup use the command create-aragon-app:

npx create-aragon-app <app-name> buidler

Structure

This boilerplate has the following structure:

root
├── app
├ ├── src
├ └── package.json
├── contracts
├ └── CounterApp.sol
├── test
├── arapp.json
├── manifest.json
├── buidler.config.js
└── package.json

• app: Frontend folder. Completely encapsulated, has its own package.json and dependencies.
  • src: Source files.
  • package.json: Frontend npm configuration file.
• contracts: Smart Constracts folder.
  • CounterApp.sol: Aragon app contract example.
• test: Tests folder.
• arapp.json: Aragon configuration file. Includes Aragon-specific metadata for your app.
• manifest.json: Aragon configuration file. Includes web-specific configurations.
• buidler.config.js: Buidler configuration file.
• package.json: Main npm configuration file.

Running your app

To run the app in a browser with front end plus back end hot reloading, simply run npm start.

Note: Right now, the Aragon Buidler plugin requires an aragen local chain running in the background, so, before running npm start, please install aragonCLI globally and run aragon devchain start. This will not be required soon.

What's in this boilerplate?

npm Scripts

• postinstall: Runs after installing dependencies.
• build-app: Installs front end project (app/) dependencies.
• start Runs your app inside a DAO.
• compile: Compiles the smart contracts.
• test: Runs tests for the contracts.

Libraries

• @aragon/os: Aragon interfaces.
• @aragon/api: Wrapper for Aragon application RPC.
• @aragon/ui: Aragon UI components (in React).
• @aragon/buidler-aragon: Aragon Buidler plugin.