https://github.com/areid987/sportsclub-v1.0.0
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (8.6%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: AReid987
- Language: TypeScript
- Default Branch: main
- Homepage: https://sportsclub-v1-0-0-web.vercel.app
- Size: 21.8 MB
Statistics
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 35
- Releases: 0
Metadata Files
README.md
🏆 Sportsclub Platform
Sports Prediction & Betting Platform - A comprehensive monorepo built with Turborepo, Next.js, and FastAPI microservices.
🚀 Quick Start
Prerequisites
- Node.js 18+ and pnpm 9+
- Python 3.11+ and PDM
- Docker and Docker Compose
Installation
Clone and install dependencies:
bash git clone <repository-url> cd sportsclub-v1.0.0 pnpm installSet up environment: ```bash cp .env.example .env
Edit .env with your configuration
```
Start development services: ```bash
Start databases (PostgreSQL, Redis, MongoDB)
docker-compose -f infra/docker/docker-compose.dev.yml up -d
# Start all applications pnpm dev ```
- Access applications:
- 🌐 Web App: http://localhost:3000
- 📚 Docs: http://localhost:3001
- 🔐 Auth Service: http://localhost:8001
- 🤖 Prediction Service: http://localhost:8002
🏗️ Architecture
Monorepo Structure
sportsclub-v1.0.0/
├── apps/ # Applications
│ ├── web/ # Next.js Frontend (Port 3000)
│ └── docs/ # Documentation Site (Port 3001)
├── packages/ # Shared packages & microservices
│ ├── shared-libs/ # Shared TypeScript types & utilities
│ ├── ui/ # Shared React components
│ ├── eslint-config/ # ESLint configurations
│ ├── typescript-config/ # TypeScript configurations
│ ├── auth-service/ # FastAPI Authentication (Port 8001)
│ ├── prediction-service/ # FastAPI Prediction Engine (Port 8002)
│ ├── data-ingestion-service/ # FastAPI Data Ingestion (Port 8003)
│ ├── ai-assistant-service/ # FastAPI AI Assistant (Port 8004)
│ ├── leaderboard-service/ # FastAPI Leaderboards (Port 8005)
│ └── notification-service/ # FastAPI Notifications (Port 8006)
├── infra/ # Infrastructure as Code
│ ├── docker/ # Docker configurations
│ ├── kubernetes/ # K8s manifests
│ ├── terraform/ # Terraform configs
│ └── aws/ # AWS CDK/CloudFormation
└── docs/ # Project documentation
Technology Stack
Frontend
- Framework: Next.js 15 with App Router
- Styling: Tailwind CSS + Radix UI
- State Management: Zustand + TanStack Query
- Animations: Framer Motion
Backend
- API Framework: FastAPI (Python 3.11+)
- Package Management: PDM
- Database: PostgreSQL + Redis + MongoDB
- Authentication: JWT + OAuth2
DevOps
- Monorepo: Turborepo
- Package Manager: pnpm
- Containerization: Docker
- CI/CD: GitHub Actions
📦 Available Scripts
```bash
Development
pnpm dev # Start all apps in development mode pnpm dev:web # Start only web app pnpm dev:docs # Start only docs
Building
pnpm build # Build all packages and apps pnpm build:web # Build only web app
Code Quality
pnpm lint # Lint all packages pnpm lint:fix # Fix linting issues pnpm check-types # Type check all TypeScript pnpm format # Format code with Prettier
Testing
pnpm test # Run all tests pnpm test:watch # Run tests in watch mode
Utilities
pnpm clean # Clean all build artifacts pnpm commit # Conventional commit with Commitizen ```
🔧 Development Workflow
Adding a New Package
- Create package directory in
packages/ - Add
package.jsonwith@sportsclub/namespace - Configure TypeScript and ESLint
- Update workspace dependencies
Adding a New Microservice
- Create service directory in
packages/ - Set up
pyproject.tomlwith PDM - Configure FastAPI application
- Add service to Docker Compose
- Update environment variables
Code Standards
- TypeScript: Strict mode enabled
- ESLint: Shared configurations
- Prettier: Consistent formatting
- Conventional Commits: Standardized commit messages
- Husky: Pre-commit hooks
🚀 Deployment
Development
bash
docker-compose -f infra/docker/docker-compose.dev.yml up
Production
```bash
Build production images
pnpm build docker-compose -f infra/docker/docker-compose.prod.yml up ```
Cloud Deployment
- Frontend: Vercel
- Backend: AWS ECS/EKS
- Database: AWS RDS + ElastiCache + DocumentDB
📚 Documentation
- API Documentation: Available at service endpoints
/docs - Component Storybook:
pnpm storybook - Architecture Docs:
docs/architecture/ - Deployment Guide:
docs/deployment/
🤝 Contributing
- Fork the repository
- Create a feature branch:
git checkout -b feature/amazing-feature - Commit changes:
git commit -m 'feat: add amazing feature' - Push to branch:
git push origin feature/amazing-feature - Open a Pull Request
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
🆘 Support
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Email: admin@twgsportsclub.com
Built with ❤️ by the Sportsclub Team
Owner
- Name: Antonio Reid
- Login: AReid987
- Kind: user
- Location: Austin, Texas
- Repositories: 9
- Profile: https://github.com/AReid987
GitHub Events
Total
- Create event: 10
- Commit comment event: 9
- Issues event: 589
- Delete event: 4
- Issue comment event: 24
- Push event: 44
- Pull request review comment event: 56
- Pull request review event: 40
- Pull request event: 21
Last Year
- Create event: 10
- Commit comment event: 9
- Issues event: 589
- Delete event: 4
- Issue comment event: 24
- Push event: 44
- Pull request review comment event: 56
- Pull request review event: 40
- Pull request event: 21
Issues and Pull Requests
Last synced: 12 months ago
All Time
- Total issues: 0
- Total pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: 2 days
- Total issue authors: 0
- Total pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 1.5
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: 2 days
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 1.5
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- AReid987 (436)
Pull Request Authors
- AReid987 (9)
- mend-bolt-for-github[bot] (1)
- dependabot[bot] (1)
- aikido-autofix[bot] (1)