Welcome to the Replay API project! This is the main project of our organization, providing robust and scalable solutions for managing and analyzing replay data from various games.
The Replay API is designed to handle large volumes of replay data, offering features such as:
- Replay Parsing: Efficiently parse and process replay files from different games.
- Data Storage: Store parsed data in a structured format using MongoDB.
- Search and Query: Powerful search and query capabilities to retrieve specific data points.
- Event Handling: Handle various game events and generate meaningful insights.
- Machine Learning Integration: Evaluate player talent and performance using machine learning models.
The Replay API supports parsing replay files from multiple games, extracting valuable data such as player actions, game events, and match statistics.
Parsed data is stored in MongoDB, allowing for efficient retrieval and analysis. The repository pattern is used to abstract database operations.
The API provides advanced search and query capabilities, enabling users to filter and retrieve specific data points based on various criteria.
The API handles different game events, such as match start, round end, and clutch situations, generating insights and statistics for each event.
The API integrates with machine learning models to evaluate player talent and performance, providing scores and insights based on in-game actions and statistics.
- Go 1.16+ (Recommended using 1.23+)
- MongoDB
-
Clone the repository:
git clone https://github.com/replay-api/replay-api.git cd replay-api
-
Install dependencies:
go mod tidy
-
Set up MongoDB:
- Ensure MongoDB is running and accessible.
- Update the MongoDB connection settings in the configuration file.
-
Build the project:
go build -o replay-api
-
Run the API:
./replay-api
Run the tests using the following command:
go test ./...
We recommend using Docker to run the Replay API for a consistent and isolated environment. You can build and run the Docker container using the following command:
make docker
To set up the Replay API using Docker Compose, follow these steps:
-
Copy the
docker-compose.example.yml
file todocker-compose.yml
:cp docker-compose.example.yml docker-compose.yml
-
Create a
.env
file and set the necessary environment variables:cp .env.example .env # Edit the .env file to set your environment variables
-
Start the services using Docker Compose:
docker-compose up
We welcome contributions from the community! Please read our Contributing Guide to get started.
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or inquiries, please contact us at [email protected].
Thank you for using the Replay API! We hope it helps you manage and analyze your replay data effectively.