Brixsport

Brixsport is a lightweight, real-time sports scoring platform designed for campuses.
It is structured with a modular branch workflow, automated pull request enforcement, and bot-controlled merges, making it ideal for branch rules and workflow automation.

---

Features

• Real-time event logging and score updates
• Progressive Web App (PWA) interface
• Modular branch workflow
• Bot-enforced pull request workflow
• Automated CI/CD and deployment checks
• Protected dev and main branches

---

Getting Started

1. Clone the repository

   git clone https://github.com/Brixsport/BrixSports.git
   cd brixsport
   

2. Install dependencies

    npm install
   

3. Start development server

    npm run dev
   

---

Branch Workflow

Branch	Purpose	Status
feature/<feature>	New feature development	Active
fix/<issue>	Bug fixes	Pending
hotfix/<issue>	Critical production fixes	Urgent
dev	Integration / staging branch	Staging
main	Production branch	Stable

Note: All commits to dev or main must go through pull requests.

---

Pull Request Guidelines

• Branch must follow naming conventions (feature/** or fix/**)
• Commit messages must follow conventional commits
• PR must be reviewed and approved before merge
• All conversations must be resolved
• All automated status checks must pass

---

License

• Brixsport is released under the MIT License. See the LICENSE file for details.