Skip to content

README.md

Latest commit

 

History

History
76 lines (59 loc) · 2.24 KB

README.md

File metadata and controls

76 lines (59 loc) · 2.24 KB

Sports Management System

Overview

The Sports Management System is a web application designed to help users efficiently organize, manage, and explore various sports-related activities. With a user-friendly interface, this system enables seamless creation, categorization, searching, and management of sports teams, events, and memberships.

Features

  • User Authentication: Secure login and registration system.
  • Team Creation & Management: Add, delete, and edit team details.
  • Categorization: Organize teams by sport type, league, and tags.
  • Search & Filter: Quickly find teams and events using keywords and filters.
  • Membership Management: Join, leave, and manage team memberships.
  • Event Management: Schedule and manage sports events.
  • Admin Panel: Manage users, categories, and the sports database.

Technologies Used

Backend

  • Java, Spring Boot, Hibernate, Kafka
  • Maven, JUnit

Database

  • PostgreSQL

Authentication

  • JWT, OAuth2, OpenID Connect

Storage

  • Local storage, AWS S3 / Firebase (planned)

Installation & Setup

Prerequisites

Ensure you have the following installed on your system:

  • Java & Spring Boot (for backend)
  • Database system (PostgreSQL)

Steps

  1. Clone the repository: 
    git clone https://github.com/andkcode/Sports-Management-System.git
cd Sports-Management-System
  2. Set up the database: 
    npx sequelize db:migrate  # For SQL databases
  3. Start the application: 
    npm run dev  # For backend

Usage

  • Register or log in.
  • Create and manage teams.
  • Search and filter teams and events.
  • Join or leave teams.
  • Schedule and manage sports events.
  • Manage user settings and preferences.

Contribution

Contributions are welcome! To contribute:

  1. Fork the repository.
  2. Create a new branch (feature-xyz).
  3. Commit your changes and push them.
  4. Submit a pull request.

License

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

Contact

For queries or collaboration, reach out at: