@@ -56,6 +56,22 @@ WHERE {
5656- ` LAST ` : use the final historical window snapshot as baseline
5757- ` AGGREGATE ` : merge the historical window outputs into one compact baseline
5858
59+ ## Repository Status
60+
61+ The backend repository is active and locally healthy:
62+
63+ - ` cargo test --all-features ` passes
64+ - ` cargo clippy --all-targets --all-features -- -D warnings ` passes
65+ - the HTTP API, Janus API, parser, storage layer, and stream bus all have integration coverage
66+
67+ This repository is the backend and engine implementation.
68+
69+ The maintained dashboard lives in a separate repository:
70+
71+ - ` https://github.com/SolidLabResearch/janus-dashboard `
72+
73+ The ` janus-dashboard/ ` folder in this repository is a lightweight local demo client, not the primary frontend.
74+
5975## Performance
6076
6177Janus uses dictionary encoding and segmented storage for high-throughput ingestion and historical reads.
@@ -65,14 +81,15 @@ Janus uses dictionary encoding and segmented storage for high-throughput ingesti
6581- Point query latency: 0.235 ms at 1M quads
6682- Space efficiency: about 40% smaller encoded events
6783
68- Detailed benchmark data is in [ BENCHMARK_RESULTS.md] ( ./BENCHMARK_RESULTS.md ) .
84+ Detailed benchmark data is in [ docs/ BENCHMARK_RESULTS.md] ( ./docs /BENCHMARK_RESULTS.md ) .
6985
7086## Quick Start
7187
7288### Prerequisites
7389
7490- Rust stable
7591- Cargo
92+ - Docker, if you want to run the local MQTT broker from ` docker-compose.yml `
7693
7794### Build
7895
@@ -140,20 +157,25 @@ The repository includes runnable examples under [`examples/`](./examples), inclu
140157- [ ` examples/comparator_demo.rs ` ] ( ./examples/comparator_demo.rs )
141158- [ ` examples/demo_dashboard.html ` ] ( ./examples/demo_dashboard.html ) for a minimal local demo
142159
143- ## Project Layout
160+ ## Documentation
161+
162+ Start here:
163+
164+ - [ GETTING_STARTED.md] ( ./GETTING_STARTED.md )
165+ - [ START_HERE.md] ( ./START_HERE.md )
166+ - [ docs/DOCUMENTATION_INDEX.md] ( ./docs/DOCUMENTATION_INDEX.md )
167+ - [ docs/README.md] ( ./docs/README.md )
168+ - [ docs/HTTP_API_CURRENT.md] ( ./docs/HTTP_API_CURRENT.md )
169+
170+ ## Notes
144171
145- - [ ` src/api ` ] ( ./src/api ) : query lifecycle and orchestration
146- - [ ` src/parsing ` ] ( ./src/parsing ) : Janus-QL parsing
147- - [ ` src/stream ` ] ( ./src/stream ) : live stream processing
148- - [ ` src/execution ` ] ( ./src/execution ) : historical execution
149- - [ ` src/storage ` ] ( ./src/storage ) : segmented RDF storage
150- - [ ` src/http ` ] ( ./src/http ) : REST and WebSocket API
151- - [ ` tests ` ] ( ./tests ) : integration and parser coverage
172+ - ` src/main.rs ` is currently a benchmark-style executable, not the main user-facing interface.
173+ - The primary user-facing entry point is ` http_server ` .
152174
153- ## License
175+ ## Licence
154176
155- This project is released under the MIT License .
177+ This code is copyrighted by Ghent University - imec and released under the MIT Licence .
156178
157179## Contact
158180
159- For questions, open an issue or contact [ Kush] ( mailto:mailkushbisen@gmail.com ) .
181+ For questions, contact [ Kush] ( mailto:mailkushbisen@gmail.com ) or open an issue in the repository .
0 commit comments