Skip to content

Commit fb15d35

Browse files
committed
Merge origin/main into codex/repo-hardening
2 parents f701e2e + fe22349 commit fb15d35

10 files changed

Lines changed: 1212 additions & 1243 deletions

File tree

GETTING_STARTED.md

Lines changed: 0 additions & 140 deletions
Original file line numberDiff line numberDiff line change
@@ -84,143 +84,3 @@ make ci-check
8484
- `README.md`
8585
- `START_HERE.md`
8686
- `docs/DOCUMENTATION_INDEX.md`
87-
88-
## Common Rust Commands
89-
90-
Here are some useful Cargo commands:
91-
92-
```bash
93-
# Build the project
94-
cargo build
95-
96-
# Build with optimizations
97-
cargo build --release
98-
99-
# Run the binary
100-
cargo run
101-
102-
# Run with arguments
103-
cargo run -- --help
104-
105-
# Run tests
106-
cargo test
107-
108-
# Run a specific test
109-
cargo test test_name
110-
111-
# Run examples
112-
cargo run --example basic
113-
114-
# Generate documentation
115-
cargo doc --open
116-
117-
# Check code without building
118-
cargo check
119-
120-
# Update dependencies
121-
cargo update
122-
123-
# Show dependency tree
124-
cargo tree
125-
126-
# Clean build artifacts
127-
cargo clean
128-
```
129-
130-
## Using Rust Analyzer
131-
132-
For the best development experience, install Rust Analyzer in your editor:
133-
134-
- **VS Code**: Install the "rust-analyzer" extension
135-
- **IntelliJ/CLion**: Rust plugin comes with IntelliJ Rust
136-
- **Vim/Neovim**: Use rust-analyzer with LSP plugins
137-
- **Emacs**: Use lsp-mode with rust-analyzer
138-
139-
## Next Steps
140-
141-
Now that you have Janus set up, here's what you can do next:
142-
143-
1. **Explore the Architecture**: Read [ARCHITECTURE.md](ARCHITECTURE.md) to understand the design
144-
2. **Read the Contributing Guide**: Check [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines
145-
3. **Start Implementing**: Begin with one of the TODO items in the roadmap
146-
4. **Write Tests**: Add tests for any new functionality
147-
5. **Improve Documentation**: Help improve docs and examples
148-
149-
## Common Issues
150-
151-
### Issue: Rust not found
152-
153-
**Solution**: Ensure Rust is installed and in your PATH. Restart your terminal after installation.
154-
155-
### Issue: Docker containers fail to start
156-
157-
**Solution**: Check if ports 7878 and 3030 are already in use:
158-
159-
```bash
160-
lsof -i :7878
161-
lsof -i :3030
162-
```
163-
164-
### Issue: Tests failing
165-
166-
**Solution**: Make sure all dependencies are up to date:
167-
168-
```bash
169-
cargo update
170-
cargo build
171-
cargo test
172-
```
173-
174-
### Issue: Compilation errors
175-
176-
**Solution**: Clean the build and rebuild:
177-
178-
```bash
179-
cargo clean
180-
cargo build
181-
```
182-
183-
## Learning Resources
184-
185-
### Rust
186-
187-
- [The Rust Book](https://doc.rust-lang.org/book/)
188-
- [Rust by Example](https://doc.rust-lang.org/rust-by-example/)
189-
- [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/)
190-
191-
### RDF and SPARQL
192-
193-
- [RDF Primer](https://www.w3.org/TR/rdf11-primer/)
194-
- [SPARQL Tutorial](https://www.w3.org/TR/sparql11-query/)
195-
- [RSP-QL Specification](https://streamreasoning.org/RSP-QL/)
196-
197-
### Stream Processing
198-
199-
- [Stream Processing Concepts](https://www.oreilly.com/library/view/streaming-systems/9781491983867/)
200-
- [RDF Stream Processing](https://streamreasoning.org/)
201-
202-
## Getting Help
203-
204-
If you need help:
205-
206-
1. **Check the documentation**: Read the existing docs and code comments
207-
2. **Search issues**: Look for similar issues on GitHub
208-
3. **Open an issue**: Create a new issue with details about your problem
209-
4. **Contact maintainers**: Email [mailkushbisen@gmail.com](mailto:mailkushbisen@gmail.com)
210-
211-
## Contributing
212-
213-
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for:
214-
215-
- How to submit pull requests
216-
- Coding standards
217-
- Testing requirements
218-
- Review process
219-
220-
## License
221-
222-
This project is licensed under the MIT License - see [LICENCE.md](LICENCE.md) for details.
223-
224-
---
225-
226-
Happy coding with Janus!

README.md

Lines changed: 34 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -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

6177
Janus 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.

START_HERE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,6 @@ cargo run --example http_client_example
2727
- `GETTING_STARTED.md`
2828
- `docs/DOCUMENTATION_INDEX.md`
2929
- `docs/HTTP_API_CURRENT.md`
30+
- `docs/README_HTTP_API.md`
31+
- `docs/QUICKSTART_HTTP_API.md`
3032
- `docs/QUICK_REFERENCE.md`

docs/DOCUMENTATION_INDEX.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ This is the shortest path to understanding the current Janus implementation.
5252
- replay endpoints
5353
- smoke-test flow
5454

55+
## Additional Current Guides
56+
57+
- [STREAM_BUS_CLI.md](./STREAM_BUS_CLI.md)
58+
- [README_HTTP_API.md](./README_HTTP_API.md)
59+
- [QUICKSTART_HTTP_API.md](./QUICKSTART_HTTP_API.md)
60+
5561
## Legacy Material
5662

5763
The following files remain useful as background, but they are not the main entrypoint for the current code:
@@ -60,6 +66,13 @@ The following files remain useful as background, but they are not the main entry
6066
- [EXECUTION_ARCHITECTURE.md](./EXECUTION_ARCHITECTURE.md)
6167
- [MVP_ARCHITECTURE.md](./MVP_ARCHITECTURE.md)
6268
- [MVP_TODO.md](./MVP_TODO.md)
69+
- [RSP_INTEGRATION_COMPLETE.md](./RSP_INTEGRATION_COMPLETE.md)
70+
- [SPARQL_BINDINGS_UPGRADE.md](./SPARQL_BINDINGS_UPGRADE.md)
71+
72+
## Dashboard Boundary
73+
74+
- Local demo dashboard in this repository: `examples/demo_dashboard.html`
75+
- Maintained dashboard repository: `https://github.com/SolidLabResearch/janus-dashboard`
6376

6477
## Related Code
6578

0 commit comments

Comments
 (0)