About
The project, the person behind it, and how you can help.
About EventOre
EventOre takes its name from Event + Ore: the raw events moving through your systems, and the useful information waiting to be uncovered. It is an open-source, multi-protocol messaging console that gives operators and engineers one place to connect, browse, live-stream, inspect, and administer Kafka, Pulsar, RabbitMQ, MQTT, JMS, AWS Kinesis, Google Cloud Pub/Sub, and Azure Service Bus — with slim deployments that include only the protocols you need.
The product is built around a modular control plane and data plane: stream providers register at runtime, and the UI reflects what your cluster actually exposes. That design supports local debugging, shared workspaces, and production Kubernetes installs with Helm and GHCR images.
- Source and project terms: GitHub repository
- Source: github.com/vijayptiwari/eventore
- Product documentation: Open the product guide
About the developer
Vijay Prakash Tiwari
Creator & maintainer of EventOre
Vijay builds tools that make event streaming and messaging infrastructure easier to run and reason about. EventOre started from the need for a single, honest console across the brokers teams already operate — without juggling separate UIs per protocol or hiding capabilities behind opaque wrappers.
He works across the full stack of the project: Spring Boot providers and APIs, the React console, Helm and CI pipelines, documentation, and the optional MCP server for AI-assisted operations.
Want to extend the codebase? See Local development in the product guide for repository layout and a working dev stack.
How to contribute
How to report issues, propose changes, and land pull requests that match the project structure.
Thank you for helping improve EventOre. Set up the local stack in the product guide, then follow the workflow below.
Ways to contribute
- Bug reports — reproducible steps, logs, and protocol or cloud preset used
- Documentation —
docs/product guides and diagrams (run SEO inject before PR) - UI — React components and live-stream workspace in
frontend/ - API & providers — Spring modules under
eventore-provider-* - Helm & CI —
deploy/helm/, Dockerfiles, GitHub Actions workflows - MCP tools —
mcp/eventore-mcpfor agent integrations
Before you open a PR
- Fork github.com/vijayptiwari/eventore and create a branch from
main. - Set up the local stack and confirm your change against at least one broker (Docker Compose brokers are enough for most work).
- Run relevant checks:
- Backend:
mvn -DskipTests package(or full tests if you touched core logic) - Frontend:
npm run buildinfrontend/ - Docs:
node docs/scripts/inject-seo.mjswhen you change HTML underdocs/
- Backend:
- Keep changes focused — one feature or fix per pull request when possible.
Pull request guidelines
- Describe what changed and why in the PR description.
- Note which protocols or deployment modes you tested (e.g. Kafka + ADMIN, READONLY smoke test).
- Include screenshots for UI changes and sample API requests for backend behavior.
- Update user-facing docs in
docs/guide/when behavior or configuration changes. - Do not commit secrets, connection strings, or real cluster credentials.
Adding a stream provider
To add or extend a protocol integration:
- Create
eventore-provider-<id>/with connector and inspector packages implementingStreamProvider. - Register
*StreamProviderAutoConfigurationinMETA-INF/spring/...AutoConfiguration.imports. - Add the module to
eventore-server/pom.xmland a Maven profile if it should be optional. - Extend
ProtocolTypeineventore-coreand the OpenAPI contract underopenapi/. - Regenerate API sources and implement delegates in
eventore-server. - Add a product guide page
docs/guide/<protocol>.html, sidebar entry indocs/js/site.js, and an entry indocs/seo/pages.json. - Document GHCR image tag in
deploy/ci-backend-images.jsonif CI should publish a slim image.
See backend/README.md § “Adding a new stream provider” for module-level detail.
Documentation contributions
- Product copy lives in
docs/guide/*.html— match existing tone and section structure. - About and contributor pages live at
docs/about.html(not in the product guide sidebar). - Regenerate SEO blocks and sitemap:
node docs/scripts/inject-seo.mjs.
Community standards
Be respectful and constructive in issues and reviews. Security-sensitive findings should be reported privately to the maintainers when possible rather than in a public issue with exploit details.
License
Review the repository’s contribution guidance and project terms before submitting a pull request.
question label or describe your use case in the issue body.