https://github.com/aragon/your-first-aragon-app
(Aragon 1) Template to help you build your first Aragon application
https://github.com/aragon/your-first-aragon-app
aragon aragon-boilerplate boilerplate
Last synced: about 1 month ago
JSON representation
(Aragon 1) Template to help you build your first Aragon application
- Host: GitHub
- URL: https://github.com/aragon/your-first-aragon-app
- Owner: aragon
- License: mit
- Created: 2019-03-01T20:45:23.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T16:49:02.000Z (about 2 years ago)
- Last Synced: 2025-04-22T19:19:26.711Z (about 1 month ago)
- Topics: aragon, aragon-boilerplate, boilerplate
- Language: JavaScript
- Homepage:
- Size: 2.13 MB
- Stars: 21
- Watchers: 9
- Forks: 16
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Your first Aragon app template
> 🕵️ [Find more boilerplates using GitHub](https://github.com/search?q=topic:aragon-boilerplate) |
> ✨ [Official boilerplates](https://github.com/search?q=topic:aragon-boilerplate+org:aragon)
Template to help you build your first Aragon application following the [tutorial from hack.aragon](https://hack.aragon.org/docs/tutorial.html)
## Running your app
To run the app in a browser with front end plus back end hot reloading, simply run `npm start`.
## 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.
### Structure
This boilerplate has the following structure:
```md
root
├── app
├ ├── src
├ ├ ├── App.js
├ ├ ├── index.js
├ ├ └── script.js
├ └── package.json
├── contracts
├ └── CounterApp.sol
├── scripts
├ └── buidler-hooks.js
├── arapp.json
├── manifest.json
├── buidler.config.js
└── package.json
```
- **app**: Frontend folder. Completely encapsulated, has its package.json and dependencies.
- **src**: Source files.
- `App.js`: Aragon app root component.
- `index.js`: Aragon app entry point.
- `script.sol`: Aragon app background script.
- [**package.json**](https://docs.npmjs.com/creating-a-package-json-file): Frontend npm configuration file.
- **contracts**: Smart Constracts folder.
- `CounterApp.sol`: Aragon app contract.
- **scripts**: Scripts folder.
- `buidler-hooks.js`: Buidler script hook.
- **test**: Tests folder.
- [**arapp.json**](https://hack.aragon.org/docs/cli-global-confg#the-arappjson-file): Aragon configuration file. Includes Aragon-specific metadata for your app.
- [**manifest.json**](https://hack.aragon.org/docs/cli-global-confg#the-manifestjson-file): Aragon configuration file. Includes web-specific configurations.
- [**buidler.config.js**](https://buidler.dev/config/): Buidler configuration file.
- [**package.json**](https://docs.npmjs.com/creating-a-package-json-file): Main npm configuration file.
### Libraries
- [**@aragon/os**](https://github.com/aragon/aragonos): Aragon interfaces.
- [**@aragon/api**](https://github.com/aragon/aragon.js/tree/master/packages/aragon-api): Wrapper for Aragon application RPC.
- [**@aragon/ui**](https://github.com/aragon/aragon-ui): Aragon UI components (in React).
- [**@aragon/buidler-aragon**](https://github.com/aragon/buidler-aragon): Aragon Buidler plugin.