⚽ Premier League API

A powerful RESTful API for managing Premier League players

🚀 Getting Started

📋 Prerequisites

• Java JDK 11 or higher
• Maven 3.6+ installed
• PostgreSQL 12+ database server
• Git for version control
• Your favorite IDE (IntelliJ IDEA recommended)

⚙️ Installation

Step	Description	Command
1️⃣	Clone the repository	git clone https://github.com/khan-sk-dev/Premier-League.git cd Premier-League
2️⃣	Configure database	Edit src/main/resources/application.properties: spring.datasource.url=jdbc:postgresql://localhost:5432/pl_data spring.datasource.username=your_username spring.datasource.password=your_password
3️⃣	Build the project	mvn clean install
4️⃣	Run the application	mvn spring-boot:run

🌐 API Access Point http://localhost:8080

📝 API Documentation

Player Management Endpoints
Operation	Endpoint	Description
📋 GET	/api/v1/player	Retrieve players with optional filtering
➕ POST	/api/v1/player	Add a new player to the database
🔄 PUT	/api/v1/player	Update existing player information
❌ DELETE	/api/v1/player/{playerName}	Remove a player from the database

📥 Request Examples

🔍 Get Players (with filters)

GET /api/v1/player?team=Arsenal&position=Forward

Response (200 OK)

[
  {
    "id": 1,
    "name": "Gabriel Jesus",
    "team": "Arsenal",
    "position": "Forward",
    "nation": "Brazil"
  },
  {
    "id": 2,
    "name": "Gabriel Martinelli",
    "team": "Arsenal",
    "position": "Forward",
    "nation": "Brazil"
  }
]

➕ Add Player

POST /api/v1/player
Content-Type: application/json

Request Body

{
  "name": "Bukayo Saka",
  "team": "Arsenal",
  "position": "Winger",
  "nation": "England"
}

Response (201 Created)

{
  "id": 3,
  "name": "Bukayo Saka",
  "team": "Arsenal",
  "position": "Winger",
  "nation": "England"
}

🔄 Update Player

PUT /api/v1/player
Content-Type: application/json

Request Body

{
  "id": 3,
  "name": "Bukayo Saka",
  "team": "Arsenal",
  "position": "Right Winger",
  "nation": "England"
}

Response (200 OK)

{
  "id": 3,
  "name": "Bukayo Saka",
  "team": "Arsenal",
  "position": "Right Winger",
  "nation": "England"
}

❌ Delete Player

DELETE /api/v1/player/Bukayo%20Saka

Response (204 No Content)

🤝 Contributing

We welcome contributions! Follow these steps to contribute to the Premier League API project: <ol align="left"> <li>Fork the repository</li> <li>Create a feature branch (<code>git checkout -b feature/amazing-feature</code>)</li> <li>Make your changes</li> <li>Commit your changes (<code>git commit -m 'Add some amazing feature'</code>)</li> <li>Push to the branch (<code>git push origin feature/amazing-feature</code>)</li> <li>Open a Pull Request</li> </ol> <p>Please make sure your code follows our coding standards and includes appropriate tests.</p> </td> </tr>

Please note that this project follows a Code of Conduct. By participating, you are expected to uphold this code.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details. <details> <summary>MIT License Summary</summary> <p> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files, to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software. </p> </details> </td> </tr>

🔮 Future Enhancements

🔐 Authentication & Authorization Implement JWT-based auth system	📊 Statistical Analysis Track player performance metrics	🌐 Team Management Team creation and roster management
⚡ Caching Layer Redis caching for improved performance	🧪 Test Coverage Comprehensive unit and integration tests	📢 Notifications Real-time updates for data changes

Connect With Me

Developed with ❤️ by khan-sk-dev

├── 📂 model/ │ │ │ │ └── 📄 Player.java │ │ │ ├── 📂 repository/ │ │ │ │ └── 📄 PlayerRepository.java │ │ │ ├── 📂 service/ │ │ │ │ ├── 📄 PlayerService.java │ │ │ │ └── 📄 PlayerServiceImpl.java │ │ │ ├── 📂 exception/ │ │ │ │ └── 📄 GlobalExceptionHandler.java │ │ │ └── 📄 PremierLeagueApplication.java │ │ └── 📂 resources/ │ │ ├── 📄 application.properties │ │ └── 📂 static/ │ └── 📂 test/ │ └── 📂 java/ │ └── 📂 com/ │ └── 📂 premierleague/ │ └── 📂 tests/ ├── 📄 .gitignore ├── 📄 mvnw ├── 📄 mvnw.cmd ├── 📄 pom.xml └── 📄 README.md

🚀 Getting Started

Prerequisites

• JDK 11 or higher
• Maven 3.6+
• PostgreSQL 12+

Installation

1. Clone the repository

   git clone https://github.com/khan-sk-dev/Premier-League.git
   cd Premier-League

2. Configure database

   Edit src/main/resources/application.properties:

   spring.datasource.url=jdbc:postgresql://localhost:5432/pl_data
   spring.datasource.username=your_username
   spring.datasource.password=your_password

3. Build the project

   mvn clean install

4. Run the application

   mvn spring-boot:run

   The API will be accessible at http://localhost:8080

📝 API Documentation

Player Endpoints

Get Players

GET /api/v1/player

Query Parameters:

• team - Filter by team name
• name - Filter by player name
• position - Filter by position
• nation - Filter by nation

Example:

GET /api/v1/player?team=Arsenal&position=Striker

Add Player

POST /api/v1/player

Request Body:

{
  "name": "Bukayo Saka",
  "team": "Arsenal",
  "position": "Winger",
  "nation": "England"
}

Update Player

PUT /api/v1/player

Request Body:

{
  "name": "Bukayo Saka",
  "team": "Arsenal",
  "position": "Right Winger",
  "nation": "England"
}

Delete Player

DELETE /api/v1/player/{playerName}

Example:

DELETE /api/v1/player/Bukayo%20Saka

🔧 Project Structure

Premier-League/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── premierleague/
│   │   │           ├── controller/
│   │   │           ├── model/
│   │   │           ├── repository/
│   │   │           ├── service/
│   │   │           └── PremierLeagueApplication.java
│   │   └── resources/
│   │       └── application.properties
│   └── test/
│       └── java/
│           └── com/
│               └── premierleague/
│                   └── tests/
├── .gitignore
├── mvnw
├── mvnw.cmd
├── pom.xml
└── README.md

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

📊 Future Enhancements

• 🔐 Authentication and authorization
• 📊 Statistical analysis of player performance
• 🌐 Team management functionality
• ⚡ Caching for improved performance
• 🧪 Comprehensive test coverage

---

Developed with ❤️ by khan-sk-dev