thevoid.cafe
Simple, single-user event aggregation platform, for use in personal websites and other related places.
event-streaming
single-user
events
event-aggregation
🎉 Initialize project
+5
.gitignore
+5
.gitignore
+37
README.md
+37
README.md
···
1
+
# Snowflake
2
+
Simple, single-user event aggregation platform, for use in personal websites and other related places.
3
+
4
+
## Features
5
+
- **Event Ingestion**: Collect and store events from various sources.
6
+
- **Event Streaming**: Stream events to external systems or APIs.
7
+
- **State Caching**: Stores calculated state of select events (refreshed/corrected periodically).
8
+
- **State Retrieval**: Retrieve state data for analysis or display.
9
+
10
+
## Documentation
11
+
I'm working on integrating documentations directly into my personal website.
12
+
There's currently no set deadline for any of this, feel free to check back later.
13
+
14
+
[For users (soon)](https://thevoid.cafe/projects/snowflake/docs)
15
+
16
+
[For developers (soon)](https://thevoid.cafe/projects/snowflake/docs/developers)
17
+
18
+
## Development Setup
19
+
### Requirements
20
+
- **Bun**: v1.3 or higher
21
+
22
+
### Installation
23
+
To install dependencies, run the following command:
24
+
```sh
25
+
bun install snowflake
26
+
```
27
+
28
+
### Execution
29
+
If you're testing for production, start Snowflake by running:
30
+
```sh
31
+
bun run prod
32
+
```
33
+
34
+
If you're a developing new features, start Snowflake in development mode by running:
35
+
```sh
36
+
bun run dev
37
+
```
+16
package.json
+16
package.json
···
1
+
{
2
+
"name": "snowflake",
3
+
"version": "0.0.1",
4
+
"description": "Simple, single-user event aggregation platform, for use in personal websites and other related places.",
5
+
"keywords": [
6
+
"event-aggregation",
7
+
"event-streaming",
8
+
"single-user",
9
+
"events"
10
+
],
11
+
"main": "src/index.ts",
12
+
"scripts": {
13
+
"dev": "bun --watch .",
14
+
"prod": "bun ."
15
+
}
16
+
}