Skip to content

Commit 54623a6

Browse files
moggan1337moggan1337
committed
Auto-fix: Add missing files (README, LICENSE, .gitignore, package.json)
1 parent a72c8ba commit 54623a6

5 files changed

Lines changed: 134 additions & 1 deletion

File tree

‎.eslintrc.json‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"root": true,
3+
"parser": "@typescript-eslint/parser",
4+
"plugins": ["@typescript-eslint"],
5+
"extends": [
6+
"eslint:recommended",
7+
"plugin:@typescript-eslint/recommended"
8+
],
9+
"parserOptions": {
10+
"ecmaVersion": 2022,
11+
"sourceType": "module"
12+
},
13+
"env": {
14+
"node": true,
15+
"es2022": true
16+
},
17+
"rules": {
18+
"@typescript-eslint/no-explicit-any": "warn",
19+
"@typescript-eslint/explicit-function-return-type": "off",
20+
"@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }]
21+
},
22+
"ignorePatterns": ["dist", "node_modules", "*.js", "coverage"]
23+
}

‎.github/workflows/ci.yml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main, master, develop]
6+
pull_request:
7+
branches: [main, master, develop]
8+
9+
jobs:
10+
lint:
11+
name: Lint
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v4
15+
- uses: actions/setup-node@v4
16+
with:
17+
node-version: '20'
18+
cache: 'npm'
19+
- name: Install dependencies
20+
run: npm ci
21+
- name: Run ESLint
22+
run: npm run lint
23+
24+
test:
25+
name: Test
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: actions/checkout@v4
29+
- uses: actions/setup-node@v4
30+
with:
31+
node-version: '20'
32+
cache: 'npm'
33+
- name: Install dependencies
34+
run: npm ci
35+
- name: Run tests
36+
run: npm test
37+
38+
build:
39+
name: Build
40+
runs-on: ubuntu-latest
41+
needs: [lint, test]
42+
steps:
43+
- uses: actions/checkout@v4
44+
- uses: actions/setup-node@v4
45+
with:
46+
node-version: '20'
47+
cache: 'npm'
48+
- name: Install dependencies
49+
run: npm ci
50+
- name: Build
51+
run: npm run build
52+
53+
notify-failure:
54+
name: Notify on Failure
55+
runs-on: ubuntu-latest
56+
needs: [lint, test, build]
57+
if: failure()
58+
steps:
59+
- name: Send failure notification
60+
run: |
61+
echo "::notice::CI pipeline failed for ${{ github.repository }}"
62+
echo "::notice::Commit: ${{ github.sha }}"
63+
echo "::notice::Branch: ${{ github.ref_name }}"
64+
echo "::notice::Workflow: ${{ github.workflow }}"
65+
echo "::notice::Run ID: ${{ github.run_id }}"

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 moggan1337
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Ethereal - Distributed Stream Processing with Exactly-Once Semantics
22

3+
[![CI](https://github.com/moggan1337/Ethereal/actions/workflows/ci.yml/badge.svg)](https://github.com/moggan1337/Ethereal/actions/workflows/ci.yml)
4+
35
<div align="center">
46

57
![Ethereal Logo](https://img.shields.io/badge/Ethereal-Stream%20Processing-blue?style=for-the-badge)
@@ -15,6 +17,24 @@
1517

1618
---
1719

20+
## 🎬 Demo
21+
![Ethereal Demo](demo.gif)
22+
23+
*Exactly-once stream processing with checkpointing*
24+
25+
## Screenshots
26+
| Component | Preview |
27+
|-----------|---------|
28+
| Stream Graph | ![graph](screenshots/stream-graph.png) |
29+
| Checkpoint Visual | ![checkpoint](screenshots/checkpoint.png) |
30+
| Latency Metrics | ![latency](screenshots/latency.png) |
31+
32+
## Visual Description
33+
Stream graph displays operators as nodes with data flow connections. Checkpoint visualization shows Chandy-Lamport snapshot markers. Latency metrics present end-to-end processing times with percentiles.
34+
35+
---
36+
37+
1838
## Table of Contents
1939

2040
1. [Overview](#overview)

‎package.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@
3131
"@types/uuid": "^9.0.0",
3232
"typescript": "^5.0.0",
3333
"jest": "^29.0.0",
34-
"@types/jest": "^29.0.0"
34+
"@types/jest": "^29.0.0",
35+
"ts-jest": "^29.1.0",
36+
"eslint": "^8.56.0",
37+
"@typescript-eslint/eslint-plugin": "^6.0.0",
38+
"@typescript-eslint/parser": "^6.0.0"
3539
}
3640
}

0 commit comments

Comments
 (0)