atiproy/cricks

Cricket Scoring API 🌐

Cricks API is a robust and secure web application built with .NET 8.0, providing cricket match scoring and management. It uses Entity Framework Core for data storage and JWT for authentication.

Table of Contents

• Features
• API Endpoints
• Setup
• Usage
• Contributing
• License
• Contact

🚀 Features

• JWT Authentication: Secure authentication using JSON Web Tokens.
• Role-based Authorization: Access control with predefined user roles.
• Entity Framework Core: Support for multiple databases including SQLite, SQL Server, MySQL, and PostgreSQL.
• Swagger UI: Interactive API documentation and testing.

📚 API Endpoints

• GET /matches: Returns a list of cricket matches.

• GET /matches/{id}: Returns a specific cricket match by ID.

• POST /matches: Creates a new cricket match.

• PUT /matches/{id}: Updates an existing cricket match.

• DELETE /matches/{id}: Deletes a cricket match.

• GET /tournament: Returns a list of tournaments.

• GET /tournament/{id}: Returns a specific tournament by ID.

• POST /tournament: Creates a new tournament.

• PUT /tournament/{id}: Updates an existing tournament.

• DELETE /tournament/{id}: Deletes a tournament.

• GET /ball: Returns a list of balls.

• GET /ball/{id}: Returns a specific ball by ID.

• POST /ball: Creates a new ball.

• PUT /ball/{id}: Updates an existing ball.

• DELETE /ball/{id}: Deletes a ball.

🛠️ Setup

Prerequisites

• .NET 8.0 or later
• SQLite, SQL Server, MySQL, or PostgreSQL

Installation

1. Clone the repository
2. Navigate to the project directory
3. Restore the packages
4. Run the application

🎮 Usage

Once the application is running, you can access the Swagger UI at http://localhost:5000/swagger.

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page. You can also take a look at the contributing guide.

📝 License

This project is MIT licensed.

📧 Contact

Created by @atiproy - feel free to contact me!

📖 Detailed Documentation

MatchesController

The MatchesController is an API controller that provides cricket match management. It has the following methods:

• GET /matches: Returns a list of cricket matches.
• GET /matches/{id}: Returns a specific cricket match by ID.
• POST /matches: Creates a new cricket match.
• PUT /matches/{id}: Updates an existing cricket match.
• DELETE /matches/{id}: Deletes a cricket match.

TournamentController

The TournamentController is an API controller that provides tournament management. It has the following methods:

• GET /tournament: Returns a list of tournaments.
• GET /tournament/{id}: Returns a specific tournament by ID.
• POST /tournament: Creates a new tournament.
• PUT /tournament/{id}: Updates an existing tournament.
• DELETE /tournament/{id}: Deletes a tournament.

BallController

The BallController is an API controller that provides ball management. It has the following methods:

• GET /ball: Returns a list of balls.
• GET /ball/{id}: Returns a specific ball by ID.
• POST /ball: Creates a new ball.
• PUT /ball/{id}: Updates an existing ball.
• DELETE /ball/{id}: Deletes a ball.

Authentication

The application uses JWT for authentication. The JWT is included in the Authorization header with the Bearer scheme.

Authorization

The application uses role-based authorization. The TournamentController requires the user to have the "Owner" role.

Database

The application uses Entity Framework Core for data storage. The connection string is configured in the appsettings.json file. It supports multiple databases including SQLite, SQL Server, MySQL, and PostgreSQL.

Swagger UI

The application includes Swagger UI for interactive API documentation and testing. You can access it at http://localhost:5000/swagger when the application is running.