https://github.com/aragon/hack
(Aragon 1) Content and source code for the Aragon Developer Portal
https://github.com/aragon/hack
aragon developer-portal documentation ethereum solidity
Last synced: about 1 month ago
JSON representation
(Aragon 1) Content and source code for the Aragon Developer Portal
- Host: GitHub
- URL: https://github.com/aragon/hack
- Owner: aragon
- License: cc0-1.0
- Created: 2018-05-14T15:49:10.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T16:58:53.000Z (over 3 years ago)
- Last Synced: 2025-04-22T19:19:58.130Z (about 1 year ago)
- Topics: aragon, developer-portal, documentation, ethereum, solidity
- Language: JavaScript
- Homepage: https://hack.aragon.org
- Size: 41.6 MB
- Stars: 31
- Watchers: 10
- Forks: 37
- Open Issues: 45
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Documentation portal for Aragon Apps 
## Running a local instance
### Prerequisites
- [`solc@v0.4.24`](https://github.com/ethereum/solidity/releases/tag/v0.4.24)
> [`solc-select`](https://github.com/crytic/solc-select) is your best friend when it comes to installing solc!
Note: `solidity-docgen` [does not work on Windows](https://github.com/OpenZeppelin/solidity-docgen/issues/22).
```sh
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 .
## Publishing
The documentation is published via [gh-pages](https://pages.github.com/). Automatic deployments are handled through an [deployment Github Action](.github/workflows/ci.yml) on pushes to the `master` branch.
If you'd like to publish it locally though, you can run:
```sh
cd website
yarn install
yarn run build
yarn run publish-gh-pages
```
Note: the `aragonOS` files **must** be generated on publish, [see issue](https://github.com/aragon/hack/issues/116).
## Contributing
Thanks for your interest in contributing to these docs!
Get started [here](https://github.com/aragon/hack/blob/master/CONTRIBUTING.md).