1.0.6 • Published 7 months ago

create-seneschal-app v1.0.6

Weekly downloads
-
License
-
Repository
-
Last release
7 months ago

MIT License npm

The Seneschal

The Seneschal Logo

The Seneschal is a powerful tool that empowers DAO operators to grant shares, loot, and rewards to value-creating participants. This tool enables the creation of piecemeal task-to-task incentives within DAOs, all while maintaining a non-coercive and high-trust environment. It's designed to enhance the functionality and flexibility of decentralized autonomous organizations.

Key Features:

  • Grant shares, loot, and rewards within your DAO.
  • Create piecemeal task-to-task incentives for participants.
  • Enhance trust and transparency in your organization.
  • Built using modern technologies like Next.js, Hats Protocol, Arweave and more.

Getting Started

This starter kit is built using Next.js, Shadcn/UI, GraphQL, OpenAI, Arweave, IPFS (using nft.storage as the provider), Hats Protocol, Subgraph, Wagmi, Viem, Ethers, and Zod.js.

Installation

To create your own instance of The Seneschal, you can use the following command:

npx create-seneschal-app --name <project-name>

Prerequisites

  • Requires the seneschal contracts to be deployed. Can be found here in this repository.
  • Requires a subgraph to your deployed seneschal contract which you can clone here. Make sure to update the contract address at subgraph.yaml.

Instructions

  • Once you have the contracts & subgraph deployed, create a Shaman Proposal in DAOHaus to grant DAO permissions to the seneschal contract.
  • Mint the necessary hats to your DAO operators & grab the hat IDs from here.
  • Using nft.storage as the IPFS provider. You can either use the same or bring your own provider. Note that, if the provider is changed, you need to make appropriate code changes as well for interacting with IPFS.
  • Update your environment variables by copying the sample environment file provided: sample.env.

Once you have your instance up and running, you can start customizing it to suit your needs.

Technologies Used

  • Next.js
  • Tailwind CSS
  • GraphQL
  • OpenAI
  • Arweave
  • IPFS (nft.storage as the provider)
  • Hats Protocol
  • Subgraph
  • Wagmi
  • Viem
  • Ethers
  • Zod.js

Authors

Contribution

We welcome contributions from the community to enhance and improve The Seneschal project. If you would like to contribute, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix: git checkout -b feature/my-feature or git checkout -b bugfix/issue-description.
  3. Make your changes and commit them with a descriptive commit message.
  4. Push your changes to your forked repository.
  5. Create a pull request to the main repository, detailing the changes you've made and any relevant information.

Copyright © 2023 SilverDoor. This project is licensed under the MIT License.