Quake Log Parser is a Go-based project that provides an HTTP interface for parsing Quake 3 Arena game log files. Users can upload log files and the application will parse the games in the logs and return structured JSON data detailing each game's players, scores, and kills.
Here's a brief outline of the project structure:
cmd/: Contains the main application that starts the server.handler/: Contains HTTP handler functions for handling requests.models/: Contains data models for the game data.parser/: Contains logic for parsing the log files.report/: Contains logic for generating the JSON reports from parsed log files.static/: Contains static HTML files served by the server.testdata/: Contains test data and expected results for unit tests.
Each of the cmd, handler, models, parser, and report directories also contain respective _test.go files for testing their functionalities.
This project uses Docker for easy setup and deployment. You can build and run the project using Docker.
Build the Docker image:
docker build -t quake-parser .This will produce an executable named quake-parser in your project root.
You can start the server by running the executable produced by the build step:
./quake-parserOnce the server is running, you can access it at http://localhost:8080.
To parse a log file, send a POST request to /upload with the log file attached as a form file under the key "qgames". The server will respond with a JSON representation of the games contained in the log.
curl -X POST -F "qgames=@/path/to/your/logfile.log" http://localhost:8080/uploadThe server will return a JSON representation of the games contained in the log.
To run the unit tests, navigate to the root directory of the project and use the go test command:
go test -v ./...This will run all the tests in the project and display the output.
Contributions are welcome! Please submit a pull request or open an issue if you have something to contribute.
This project is licensed under the MIT License - see the LICENSE.md file for details.