From 2ca7219760e5fadde17af205f789000a55e38557 Mon Sep 17 00:00:00 2001 From: "Chadrak (shad-rak)" <89146273+chadrakdev@users.noreply.github.com> Date: Thu, 7 Aug 2025 09:06:43 +0100 Subject: [PATCH] Create draft README.md --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9d5c574 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# HoopInsights API + +**HoopInsights API** is a backend-focused .NET application that integrates with the NBA data API created by [balldontlie.io](https://www.balldontlie.io) to provide advanced statistical data, such as: + +- Daily, weekly and monthly point differentials +- Statistical leaders in points, rebounds, assists, and fouls +- Team offensive and defensive averages +- Player performance trends against specific teams + +This API is structured to support future integration with a frontend application, providing a comprehensive platform for NBA statistical analysis. + +## Key Features + +- **Data Aggregation**: Fetches and processes data from balldontlie.io. +- **Testing Suite**: Includes XUnit tests with Moq and FluentAssertions. +- **Modular Architecture**: Built with SOLID principles and Domain-Driven Design. +- **Advanced Analytics**: Computes metrics like net ratings and player efficiency. + +Technologies: .NET MVC, PostgreSQL + +## Getting Started + +1. Clone the repository. +2. Configure your environment variables. +3. Run the application using Docker or your preferred method. +4. Use Postman to interact with the API endpoints. + +## Future Enhancements + +- Add Docker configuration for containerisation +- Expand analytics to include player efficiency ratings and usage +- Implement a dynamic and responsive frontend to display and query data +- Introduce caching mechanisms for common API calls to optimise performance +Use Control + Shift + m to toggle the tab key moving focus. Alternatively, use esc then tab to move to the next interactive element on the page. +No file chosen +Attach files by dragging & dropping, selecting or pasting them. +Editing HoopInsightsApi/README.md at main ยท chadrakdev/HoopInsightsApi