(as opposed to Artificial Intelligence)
Welcome! We're a student team at Sam Houston State University building Mini-SIEM for COSC 4319 Software Engineering. Our goal is to make security events easier to collect, understand, and investigate while learning how to build software together.
Mini-SIEM is a small Security Information and Event Management (SIEM) application. We're working toward a system that can:
- Import and validate sample security events.
- Apply detection rules and generate alerts.
- Search events, investigate alerts, and track incidents.
- Manage user access, record audit activity, and produce reports.
The project is under active development. Check the mini-siem repository for current progress and code.
| Area | Tools |
|---|---|
| Frontend | React, TypeScript, Vite |
| Backend | Java 21, Spring Boot |
| Database | PostgreSQL, Flyway |
| Local development | Docker Compose, GitHub Desktop |
| Testing | JUnit 5, Playwright |
Head to our mini-siem repository in the organization's Repositories tab. Its README.md explains the project structure and links to everything you need.
- New to the project? Read
docs/software-installation-guide.md. - Setting up the database? Start with
docs/database-quickstart.md. - Working on a feature? Check the User Requirements Specification, System Design, and Team Style Guide in
docs/.
We aim for readable code, simple solutions, clear communication, and steady progress. Start new work on a feature branch, test your changes, and open a pull request so the rest of the team can follow along.
We use fictional or sanitized security data for this class project, and we keep passwords, private keys, and local database files out of Git.
Our project repositories will stay private during the semester, at least until the relevant project deadlines have passed.
Thanks for stopping by! :)