Skip to content

Latest commit

 

History

History
91 lines (62 loc) · 2.87 KB

README.md

File metadata and controls

91 lines (62 loc) · 2.87 KB

Catalyst Voices

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

Overview

This monorepo serves as a unified codebase for the Catalyst Voices ecosystem projects. 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/catalyst-voices.git
cd catalyst-voices
  1. Navigate to individual project folders and follow their respective setup instructions.

Projects

Athena

Athena is our [brief description of what Athena does].

  • Directory: athena
  • Setup: Navigate to ./athena.
  • Documentation: [Link to detailed documentation or Wiki]

Catalyst Voices

Catalyst Voices frontend.

  • **Directory **: catalyst_voices
  • Setup: Navigate to ./catalyst_voices.
  • Documentation: [Link to detailed documentation or Wiki]

Catalyst Data Gateway

The backend services for Catalyst Voices.

  • **Directory **: catalyst-voices-backend
  • Setup: Navigate to ./catalyst-gateway.
  • Documentation: [Link to detailed documentation or Wiki]

Catalyst Voices Packages

Shared Flutter and Dart packages used across the Catalyst.

  • **Directory **: catalyst_voices_libs
  • Setup: Navigate to ./catalyst_voices/packages/libs.
  • Documentation: [Link to detailed documentation or Wiki]

Development

For development guidelines, tooling information, and best practices, visit Catalyst Engineering and Catalyst CI.

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.