thevoid.cafe / snowflake
Simple, single-user event aggregation platform, for use in personal websites and other related places.
event-streaming single-user events event-aggregation
fork atom
1 2 0

Clone this repository

https://tangled.org/thevoid.cafe/snowflake https://tangled.org/did:plc:jzipyzvpwhyfnn3jeymuabfv/snowflake
git@tangled.org:thevoid.cafe/snowflake git@tangled.org:did:plc:jzipyzvpwhyfnn3jeymuabfv/snowflake

For self-hosted knots, clone URLs may differ based on your setup.

Download tar.gz
README.md

Snowflake#

Simple, single-user event aggregation platform, for use in personal websites and other related places.

Features#

  • Event Ingestion: Collect and store events from various sources.
  • Event Streaming: Stream events to external systems or APIs.
  • State Caching: Stores calculated state of select events (refreshed/corrected periodically).
  • State Retrieval: Retrieve state data for analysis or display.

Documentation#

I'm working on integrating documentations directly into my personal website. There's currently no set deadline for any of this, feel free to check back later.

For users (soon)

For developers (soon)

Development Setup#

Requirements#

  • Bun: v1.3 or higher

Installation#

To install dependencies, run the following command:

bun install snowflake

Execution#

If you're testing for production, start Snowflake by running:

bun run prod

If you're a developing new features, start Snowflake in development mode by running:

bun run dev