sliptype / hack

(Aragon 1) Content and source code for the Aragon Developer Portal

Documentation portal for Aragon Apps

Running a local instance

Prerequisites

• solc@v0.4.24

solc-select is your best friend when it comes to installing solc!

Note: solidity-docgen does not work on Windows.

git clone https://github.com/aragon/hack.git
cd hack/website
yarn install
yarn start

This should open your local instance of these docs in your browser at http://localhost:3000/.

Publishing

The documentation is published via gh-pages. Automatic deployments are handled through an deployment Github Action on pushes to the master branch.

If you'd like to publish it locally though, you can run:

cd website
yarn install
yarn run build
yarn run publish-gh-pages

Note: the aragonOS files must be generated on publish, see issue.

Contributing

Thanks for your interest in contributing to these docs! Get started here.