Overview

aragonUI 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 the Aragon ecosystem, and can be used on both the client and server side.

Features

• React library: aragonUI is built using React, allowing for easy integration into React-based projects.
• Integration with Aragon ecosystem: The components provided by aragonUI are designed to feel integrated with the Aragon ecosystem, creating a seamless user experience.
• Client and server side usage: aragonUI can be used both on the client side, in web browsers, and on the server side, allowing for flexible implementation.

Installation

To install aragonUI, follow these steps:

1. Install aragonUI and styled-components from npm:

npm install aragon-ui styled-components

2. Copy the necessary assets into your public directory. You can use the provided copy-aragon-ui-assets command to do this:

copy-aragon-ui-assets

By default, this will create a directory named aragon-ui in your public directory. If you want to specify a different path, you can use the assetsUrl prop in the <Main> component.

3. Wrap your app with the <Main> component to make aragonUI available:

import { Main } from 'aragon-ui';

function App() {
  return (
    <Main assetsUrl="path/to/assets">
      {/* Your app code here */}
    </Main>
  );
}

With these steps, your project is now ready to use aragonUI. Visit https://ui.aragon.org/ for a list of available components and usage guides.

Summary

aragonUI is a React library that provides components for building user interfaces in the Aragon ecosystem. It offers seamless integration, can be used on both the client and server side, and comes with detailed documentation for easy implementation. With aragonUI, developers can create user interfaces that feel native to the Aragon platform.