input-output-hk / hermes

🏛️ Hermes is a high-availability blockchain voting database that acts as a distributed storage and event processor for voting events, proposals, and actions.

Hermes

Welcome to the Hermes mono repo, where we manage and maintain the interconnected projects.

• Hermes
  • Overview
  • Getting Started
  • Projects
    • Hermes
    • Dashboard
  • Development
  • Contributing
  • License

Overview

This monorepo serves as a unified codebase for the Hermes project. Using a monorepo simplifies our dependency management, streamlines testing, and fosters code sharing.

Getting Started

1. Clone this repository:

git clone https://github.com/input-output-hk/hermes.git
cd hermes

2. Install global dependencies:

TODO: Add global dependencies

3. Navigate to individual project folders and follow their respective setup instructions.

Projects

Hermes

High-Availability Blockchain Voting Database.

• Directory: hermes
• Setup: Navigate to ./hermes and run TODO.
• Documentation: [Link to detailed documentation or Wiki]

Dashboard

Hermes Admin Dashboard.

• Directory: dashboard
• Setup: Navigate to ./dashboard and run TODO.
• Documentation: [Link to detailed documentation or Wiki]

Development

For development guidelines, tooling information, and best practices, see DEVELOPMENT.md.

Contributing

We welcome contributions from the community! Please read our CONTRIBUTING for guidelines on how to contribute.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.