README.md

⚠️ If you are looking for the Apiary paper, it has been moved to the apiary-paper repo.

ℹ️ This document is for the newest unstable version of Apiary. If you're looking for the released version, click here.

Apiary Explorer

The goal of Apiary Explorer is to provide a way for users to discover, explore, and more effectively participate in Aragon organizations.

It is an evolution of the now defunct daolist.io and site developed and maintained by @onbjerg and the Apiary curation market proposal described here that has since been partially implemented as Aragon Fundraising. The project has been adopted under the 1Hive umbrella to continue our goal of helping open source communities thrive by making it easier for patrons to support promising open source projects and open source projects to attract and reward contributors.

Apiary is designed to be user-centric rather than organization centric, enabling users to explore and participate in many organizations. Emphasis is placed on curation and discovery. Organizations can be sorted and filter based on usage statistics (which apps are installed, activity level, amount of funding, or user profiles). We also plan to offer a user curated tagging system.

Design

There are two components in Apiary:

api

A GraphQL API. Interactive documentation for the API is available if you visit the endpoint in the browser.

Configuration

Environment Variable	Description	Default
Database
MONGODB_URI	Required. The URI of the MongoDB instance to connect to	mongodb://localhost:27017
MONGODB_NAME	Required. The name of the MongoDB database to connect to	daolist
GRAPH_ARAGON_CONNECT	Required. The full URL to the Aragon Connect subgraph	None (required)
NETWORK_ID	Required. The network ID of the Ethereum node.
ETH_NODE	Required. The Ethereum node to connect to.
Misc
PORT	The port to listen for requests on	4000
LOG_LEVEL	The log level	info

website

The explorer front-end itself, built in React with Aragon UI.

Configuration

Environment Variable	Description	Default
API_URL	The URI of the GraphQL API to connect to	https://daolist.1hive.org

Setup

# Clone the repository
git clone [email protected]:1Hive/apiary
cd apiary

# Install the dependencies
for dir in ./*; do (cd "$dir" && npm i); done

# Start the components
for dir in ./*; do (cd "$dir" && npm start); done

Alternatively you can use Docker Compose:

docker-compose up

The API will be available at localhost:3000 and the website will be available at localhost:8888.

Release

• The API can be found at https://daolist.1hive.org
• The website can be found at https://apiary.1hive.org

Contributing

Please review the code of conduct

License

GPLv3

Authors

• Oliver Nordbjerg (@onbjerg)
• Luke Duncan (@lkngtn)