Skip to content

Includes the tools and smart contracts to manage the decentralized autonomous collective (DAC).

License

Notifications You must be signed in to change notification settings

agoralabs-sh/decentralized-autonomous-collective

Repository files navigation

Agora labs logo

Decentralized Autonomous Collective

GitHub release GitHub Release Date - Published_At

GitHub License GitHub Release Date - Published_At

GitHub License

This repo provides the tools, docs and smart contracts to manage the Decentralized Autonomous Collective (DAC) that underpins the structure and inner workings of Agora Labs.

Table of contents

Back to top ^

🪄 1. Usage

Please refer to the documentation on how to manage the DAC.

Back to top ^

🛠 2. Development

2.1. Overview

Below is a quick outline of the structure of the app:

.
├── cmd                        # Go apps.
|   ├── stinger
|   │   └── main.go            # Entry point for the app.
│   └── ...
└── internal                   # A collection of reusable modules.
    ├── command                # A collection of commands.
    |   └── somecommand.go
    |   └── ...
    └── ...

2.2. Requirements

Back to top ^

2.3. Setup

  1. Install the Python dependencies
pip install -r requirements.txt
  1. Install the Go dependencies:
go mod tidy
  1. Install Algorand private network (optional):
./bin/install_algorand.sh

Back to top ^

2.4. Build

  • To build simply run:
./bin/build.sh

NOTE: This will compile the source code into a binary and move smart contracts to the .build/ directory.

2.5. Run

  1. To check the CLI compiled correctly:
./build/dac version

Back to top ^

📑 3. Appendix

3.1. Useful Scripts

Command Description
./bin/compile.sh Compiles the PyTeal contracts into TEAL code into the .build/applications/<application_name>/ directory.
./bin/build.sh Builds the CLI tool and compiles contracts into the .build/ directory.
./bin/install_algorand.sh Installs a private Algorand network.
./bin/package.sh Zips up the build files into a zip file.
./bin/start_algorand.sh Starts up the private Algorand network
./bin/test.sh Starts up the Algorand private network and runs tests against it.
./bin/version.sh Sets the version in the VERSION file.

👏 4. How to Contribute

Please read the Contributing Guide to learn about the development process.

Back to top ^

📄 5. License

Please refer to the LICENSE file.

Back to top ^

About

Includes the tools and smart contracts to manage the decentralized autonomous collective (DAC).

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published