Skip to content

Create draft README.md #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chadrakdev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create draft README.md #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

<b>Technologies:</b> .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