https://github.com/3box/keramik
A k8s operator for simulating Ceramic networks
https://github.com/3box/keramik
Last synced: 4 months ago
JSON representation
A k8s operator for simulating Ceramic networks
- Host: GitHub
- URL: https://github.com/3box/keramik
- Owner: 3box
- License: other
- Created: 2023-04-12T15:48:52.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T21:08:02.000Z (about 2 years ago)
- Last Synced: 2024-05-22T16:29:21.122Z (about 2 years ago)
- Language: Rust
- Size: 5.27 MB
- Stars: 3
- Watchers: 6
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Keramik
Keramik is a Kubernetes operator for simulating Ceramic networks.
The `k8s` directory contains the kubernetes manifests for deploying Keramik.
## Getting Started
See the [online documentation](https://3box.github.io/keramik/), or follow the steps below to build the docs.
### Local Documentation
Documentation is done using [mdbook](https://rust-lang.github.io/mdBook/guide/installation.html)
cargo install mdbook
Book source can then be found in [keramik](./keramik) and can be viewed locally with
make book-serve
## Contributing
Contributions are welcome! Opening an issue to discuss your idea is a good first step.
When you are ready please use [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) messages in your commits and PR titles.