|
1 | | -This repository contains services and deployment configurations for the [synchronic web journal](https://github.com/sandialabs/sync-journal). |
| 1 | +# Synchronic Web Services |
| 2 | + |
| 3 | +This repository contains services and deployment configurations for the [Synchronic Web Journal](https://github.com/sandialabs/sync-journal) and [Synchronic Web Records](https://github.com/sandialabs/sync-records). It provides both ready-to-deploy, all-in-one Compose environments and individual microservice components that support Synchronic Web applications. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## Repository Structure |
| 8 | + |
| 9 | +- **compose/** |
| 10 | + Pre-packaged, batteries-included Docker Compose environments for deploying Synchronic Web journals and supporting services. |
| 11 | + - Each subdirectory (e.g., `ledger/`, `ontology/`) contains everything needed to launch a complete application stack, including configuration, orchestration, and example scripts. |
| 12 | + - Ideal for users who want to quickly deploy a working Synchronic Web journal with minimal setup. |
| 13 | + |
| 14 | +- **services/** |
| 15 | + Standalone microservice components that provide additional functionality to composed deployments. |
| 16 | + - These are not full applications by themselves, but are designed to be integrated into Compose environments or other orchestration systems. |
| 17 | + - Example: the `explorer` service provides a point-and-click front-end for exploring Synchronic Web record and ledger interfaces. |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## Getting Started |
| 22 | + |
| 23 | +To get started, choose a Compose environment that matches your use case: |
| 24 | + |
| 25 | +- [compose/ledger/README.md](compose/ledger/README.md): Deploy a ledger journal for cryptographically verifiable record-keeping. |
| 26 | +- [compose/ontology/README.md](compose/ontology/README.md): Deploy an ontology journal for semantic data and provenance workflows. |
| 27 | + |
| 28 | +Each Compose README provides step-by-step instructions, required environment variables, and example usage. These environments are designed for rapid deployment and experimentation—just follow the linked guides for details. |
| 29 | + |
| 30 | +If you want to run or develop individual microservices, see the README in each service directory (e.g., [services/explorer/README.md](services/explorer/README.md)). |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +## Related Projects |
| 35 | + |
| 36 | +- **[sync-journal](https://github.com/sandialabs/sync-journal):** |
| 37 | + The core Synchronic Web Journal SDK. Provides the main ledger, record, and evaluation engine. |
| 38 | + |
| 39 | +- **[sync-records](https://github.com/sandialabs/sync-records):** |
| 40 | + A collection of reusable Scheme modules and test suites for advanced record and ledger operations. |
| 41 | + |
| 42 | +--- |
| 43 | + |
| 44 | +## Contributing |
| 45 | + |
| 46 | +Contributions are welcome! Please open issues or pull requests for new services, improvements to Compose environments, or documentation updates. |
0 commit comments