aragon / aragen

(Aragon 1) Generate an Aragon environment
GNU General Public License v3.0
20 stars 27 forks source link

AraGen Build Status npm

Generate an Aragon environment

Requirements

How to

npm i
npm run gen
npm start

Yes, you are done. Happy hacking 🔥🦅!

If you happen to stop ganache, just:

npm run start-ganache

Using snapshots

The Aragen package published to NPM contains a ganache snapshot that can be used to quickly start a chain with the entire Aragon system ready.

By default it has set up:

To use directly with ganache-cli:

npm install @aragon/aragen
npx aragen start

If you wish to access from code, for example to run ganache-core directly:

const aragonSnapshot = path.resolve(
  require.resolve("@aragon/aragen"),
  "../aragon-ganache"
);

CI

If you need to trigger the CI so a new snapshot is generated and publish to NPM, you need to tag the release by bumping the NPM version and commit to master.

npm version [major, minor, patch]

Getting help

If you need help, please reach out to Aragon core contributors and community members on Spectrum. We'd love to hear from you and know what you're working on!