Skip to content

Commit

Permalink
Merge pull request #23 from btbytes/main
Browse files Browse the repository at this point in the history
(fix) incorrect aggregation script location
  • Loading branch information
ameyc authored Aug 17, 2024
2 parents 4ac04b4 + 6c2821f commit 1f6f8ef
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,25 @@
Denormalized is a fast embeddable stream processing engine built on Apache DataFusion.
It currently supports kafka as a real-time source and a sink, windowed aggregations, and stream joins.

This repo is still a *work-in-progress* and we are actively seeking design partners. If you have have a specific use-case you'd like to discuss please drop us a line via a github issue or email [email protected].

## Quickstart
## Quick Start

### Prerequisites

- Docker
- Rust/Cargo installed

### Running an example

1. Start kafka in docker `docker run -p 9092:9092 --name kafka apache/kafka`
2. Start emitting some sample data: `cargo run --example emit_measurements`
3. Run a [simple streaming aggregation](./examples/examples/simple_aggregation.rs) on the data using denormalized: `cargo run --example emit_measurements`
3. Run a [simple streaming aggregation](./examples/examples/simple_aggregation.rs) on the data using denormalized: `cargo run --example simple_aggregation`

## More examples

A more powerful example can be seen in our [kafka ridesharing example](./docs/kafka_rideshare_example.md)
A more powerful example can be seen in our [Kafka ridesharing example](./docs/kafka_rideshare_example.md)

## Roadmap

- [x] Stream aggregation
- [x] Stream joins
- [ ] Checkpointing / restoration
Expand All @@ -38,5 +39,6 @@ A more powerful example can be seen in our [kafka ridesharing example](./docs/ka

## Credits

Denormalized is built and maintained by [Denormalized](https://www.denormalized.io) in San Francisco. Please drop in a line to
[email protected] or simply open up a GitHub Issue!
Denormalized is built and maintained by [Denormalized](https://www.denormalized.io) in San Francisco.

This repo is still a *work-in-progress* and we are actively seeking design partners. If you have have a specific use-case you'd like to discuss please drop us a line via a [github issue](https://github.com/probably-nothing-labs/denormalized/issues) or email `[email protected]`.

0 comments on commit 1f6f8ef

Please sign in to comment.