\n\n## Overview\n\naragonUI is a React library used to build user interfaces for Aragon and its related projects. It provides the components needed to build experiences that feel integrated with Aragon ecosystem, and can be used both client or server side.\n\nThe complete documentation can be found on the [aragonUI website](https://ui.aragon.org/).\n\n## Getting Started\n\nIf you are unfamiliar with aragonUI, we recommend you to start with the [getting started page](https://ui.aragon.org/getting-started/). If you only want to know how to add aragonUI to your project, have a look at the quick setup:\n\n### Quick setup\n\nInstall aragonUI alongside styled-components from npm:\n\n```sh\nnpm install --save @aragon/ui styled-components\n```\n\nCopy its assets into your public directory:\n\n```sh\nnpx copy-aragon-ui-assets ./public\n```\n\nWrap your app with the `Main` component:\n\n```jsx\nimport React from 'react'\nimport { Main } from '@aragon/ui'\n\nfunction App() {\n return (\n \n
Hello aragonUI!
\n \n )\n}\n```\n\n_Your project is now ready to use aragonUI. 💫_\n\nOpen https://ui.aragon.org/ to see the list of the available components and learn how to use them.\n\n### Assets\n\naragonUI require some assets (e.g. fonts) in order to work properly. These need to be copied where they can be accessed by the library, like the `public/` directory of a project using [Create React App](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-assets-outside-of-the-module-system).\n\nCopy these assets using the provided `copy-aragon-ui-assets` command:\n\n```sh\nnpx copy-aragon-ui-assets ./public\n```\n\nBy default, it will create a directory named `aragon-ui` in the specified directory.\n\nThis emplacement is communicated to the library through the `` component. The default path is `./aragon-ui/`, but you can change it using the `assetsUrl` prop:\n\n```jsx\nimport { Main } from '@aragon/ui'\n\nconst App = () => (\n \n
Hello aragonUI!
\n \n)\n```\n\nYou may also want to add it as a build step in your project, so that aragonUI can be upgraded without having to worry about this.\n\n```json\n\"scripts\": {\n \"sync-assets\": \"copy-aragon-ui-assets ./public\",\n \"build\": \"npm run sync-assets && react-scripts build\",\n \"start\": \"npm run sync-assets && react-scripts start\"\n}\n```\n\nSee `copy-aragon-ui-assets -h` for more information.\n\n## Build and Develop\n\nClone this repository, install the dependencies:\n\n```sh\nnpm install\n```\n\nBuild:\n\n```sh\nnpm run build\n```\n\nAuto rebuild:\n\n```sh\nnpm run dev\n```\n\nRun the devbox (to develop a component in isolation):\n\n```sh\n# Assuming you are in the root aragon-ui directory (i.e. cd aragon-ui/)\n\n# Link @aragon/ui locally and into the devbox package\nyarn link\ncd devbox/\nyarn link @aragon/ui\ncd ../\n\n# Run devbox\nyarn devbox\n```\n\n## Projects using aragonUI\n\n- [Aragon client](https://github.com/aragon/aragon) and [core apps](https://github.com/aragon/aragon-apps)\n- [Autark’s Open Enterprise](https://www.autark.xyz/apps)\n- [1Hive’s Dandelion apps](https://1hive.org/projects/dandelion-orgs/dandelion-overview)\n- [Aragon Black’s Fundraising](https://fundraising.aragon.black/)\n- [pando](https://github.com/pandonetwork/pando)\n- [P2P Models Wiki](https://github.com/P2PModels/wiki)\n- [Auction App for Cyber Foundation](https://github.com/cybercongress/aragon-auction-app)\n- [1Hive’s Apiary](https://github.com/1Hive/apiary)\n- [Uniswap Aragon App](https://github.com/empowerthedao/uniswap-aragon-app)\n- [Compound Aragon App](https://github.com/empowerthedao/compound-aragon-app)\n- [Aragon Parliament](https://github.com/PeterMPhillips/aragon-parliament)\n- [Aragon Market](https://github.com/proofoftom/aragon-market)\n\n## License\n\nMIT, see [LICENSE](LICENSE).\n","readmeFilename":"README.md"}
![\"aragonUI\"](\"https://user-images.githubusercontent.com/36158/53582039-04dd2d00-3b7f-11e9-8460-803ed3b84cc6.png\")