Skip to content

Commit b6aae57

Browse files
author
AI Assistant
committed
feat: complete project setup with comprehensive structure
- Add complete AI backend structure with OpenAI Agent SDK - Add Next.js 14 web platform with Hero UI components - Add shared types, schemas, and constants - Add comprehensive documentation structure - Add GitHub workflows for CI/CD, security audits - Add Docker configuration for development and production - Add scripts for deployment, testing, and development - Add proper environment file templates (env.example, env.local.example) - Add code quality tools (ruff, mypy, eslint, prettier) - Add community files (CODE_OF_CONDUCT, CONTRIBUTING) - Remove old .gitkeep files after structure completion This completes the foundational setup for the Sport Scribe platform following the multi-agent AI architecture with Supabase backend.
1 parent 95c3c79 commit b6aae57

32 files changed

Lines changed: 1655 additions & 10 deletions

‎.github/CODEOWNERS‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Sport Scribe Code Owners
2+
#
3+
# Global owners for fallback
4+
* @vibing-ai
5+
6+
# AI Backend
7+
/ai-backend/ @vibing-ai
8+
/ai-backend/agents/ @vibing-ai
9+
/ai-backend/tools/ @vibing-ai
10+
/ai-backend/config/ @vibing-ai
11+
12+
# Web Platform
13+
/web/ @vibing-ai
14+
/web/app/ @vibing-ai
15+
/web/components/ @vibing-ai
16+
/web/lib/ @vibing-ai
17+
18+
# Shared code
19+
/shared/ @vibing-ai
20+
/shared/types/ @vibing-ai
21+
/shared/schemas/ @vibing-ai
22+
23+
# Documentation
24+
/docs/ @vibing-ai
25+
*.md @vibing-ai
26+
27+
# CI/CD and DevOps
28+
/.github/ @vibing-ai
29+
/scripts/ @vibing-ai
30+
docker-compose*.yml @vibing-ai
31+
Dockerfile @vibing-ai
32+
33+
# Configuration files
34+
.env.example @vibing-ai
35+
requirements*.txt @vibing-ai
36+
package*.json @vibing-ai
37+
tsconfig.json @vibing-ai
38+
tailwind.config.js @vibing-ai
39+
40+
# Security and compliance
41+
.pre-commit-config.yaml @vibing-ai
42+
/.github/workflows/security-audit.yml @vibing-ai

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: ['bug', 'triage']
6+
assignees: ''
7+
8+
---
9+
10+
## Bug Description
11+
A clear and concise description of what the bug is.
12+
13+
## Steps to Reproduce
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
## Expected Behavior
21+
A clear and concise description of what you expected to happen.
22+
23+
## Actual Behavior
24+
A clear and concise description of what actually happened.
25+
26+
## Screenshots
27+
If applicable, add screenshots to help explain your problem.
28+
29+
## Environment
30+
**Platform:** (AI Backend / Web Platform / Both)
31+
32+
**AI Backend:**
33+
- Python version: [e.g. 3.11]
34+
- OpenAI Agent SDK version: [e.g. 0.1.0]
35+
- OS: [e.g. Ubuntu 20.04]
36+
37+
**Web Platform:**
38+
- Browser: [e.g. chrome, safari]
39+
- Version: [e.g. 22]
40+
- Node.js version: [e.g. 18.17.0]
41+
- Next.js version: [e.g. 14.0.0]
42+
43+
## Additional Context
44+
Add any other context about the problem here.
45+
46+
## Error Logs
47+
```
48+
Paste any relevant error logs here
49+
```
50+
51+
## Possible Solution
52+
If you have a suggestion for how to fix the bug, please describe it here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Discussions
4+
url: https://github.com/vibing-ai/sport-scribe/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: 📚 Documentation
7+
url: https://github.com/vibing-ai/sport-scribe/tree/main/docs
8+
about: Check our documentation for guides and API references
9+
- name: 🐛 Security Issues
10+
url: https://github.com/vibing-ai/sport-scribe/security/advisories
11+
about: Report security vulnerabilities privately

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: ['enhancement', 'triage']
6+
assignees: ''
7+
8+
---
9+
10+
## Feature Summary
11+
A clear and concise description of the feature you'd like to see.
12+
13+
## Problem Statement
14+
**Is your feature request related to a problem? Please describe.**
15+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
16+
17+
## Proposed Solution
18+
**Describe the solution you'd like**
19+
A clear and concise description of what you want to happen.
20+
21+
## Alternative Solutions
22+
**Describe alternatives you've considered**
23+
A clear and concise description of any alternative solutions or features you've considered.
24+
25+
## Use Cases
26+
Describe specific use cases where this feature would be valuable:
27+
1. Use case 1...
28+
2. Use case 2...
29+
3. Use case 3...
30+
31+
## Platform Impact
32+
**Which parts of the system would this affect?**
33+
- [ ] AI Backend (Python agents)
34+
- [ ] Web Platform (Next.js frontend)
35+
- [ ] Database schema
36+
- [ ] API endpoints
37+
- [ ] Documentation
38+
- [ ] Other: ___
39+
40+
## Implementation Details
41+
If you have technical ideas about how this could be implemented, please describe them:
42+
43+
```
44+
Optional code examples or pseudocode
45+
```
46+
47+
## Priority Level
48+
**How important is this feature to you?**
49+
- [ ] Critical (blocking current work)
50+
- [ ] High (would significantly improve workflow)
51+
- [ ] Medium (nice to have)
52+
- [ ] Low (minor improvement)
53+
54+
## Additional Context
55+
Add any other context, mockups, or screenshots about the feature request here.
56+
57+
## Related Issues
58+
Link any related issues or discussions:

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
## Description
2+
Brief description of the changes in this PR.
3+
4+
## Type of Change
5+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
6+
- [ ] ✨ New feature (non-breaking change which adds functionality)
7+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
8+
- [ ] 📚 Documentation update
9+
- [ ] 🔧 Maintenance (dependencies, CI, build tools, etc.)
10+
- [ ] ♻️ Refactoring (no functional changes)
11+
- [ ] ⚡ Performance improvement
12+
13+
## Changes Made
14+
- Change 1
15+
- Change 2
16+
- Change 3
17+
18+
## Testing
19+
**How has this been tested?**
20+
- [ ] Unit tests added/updated
21+
- [ ] Integration tests added/updated
22+
- [ ] Manual testing performed
23+
- [ ] No testing required (documentation, etc.)
24+
25+
**Test Configuration:**
26+
- Python version: [e.g. 3.11]
27+
- Node.js version: [e.g. 18.17.0]
28+
- Browser (if applicable): [e.g. Chrome 119]
29+
30+
## Platform Impact
31+
**Which parts of the system are affected?**
32+
- [ ] AI Backend (Python agents)
33+
- [ ] Web Platform (Next.js frontend)
34+
- [ ] Database schema
35+
- [ ] API endpoints
36+
- [ ] Documentation
37+
- [ ] CI/CD workflows
38+
- [ ] Other: ___
39+
40+
## Breaking Changes
41+
**Does this PR introduce any breaking changes?**
42+
- [ ] No breaking changes
43+
- [ ] Yes, breaking changes (please describe below)
44+
45+
If yes, describe the breaking changes and migration path:
46+
47+
## Checklist
48+
**Before requesting a review, please ensure:**
49+
- [ ] Code follows the project's style guidelines
50+
- [ ] Self-review of code has been performed
51+
- [ ] Code is commented, particularly in hard-to-understand areas
52+
- [ ] Corresponding changes to documentation have been made
53+
- [ ] Changes generate no new warnings
54+
- [ ] Tests pass locally
55+
- [ ] Any dependent changes have been merged and published
56+
57+
## Screenshots (if applicable)
58+
Add screenshots to help explain your changes.
59+
60+
## Related Issues
61+
Closes #(issue_number)
62+
Related to #(issue_number)
63+
64+
## Additional Notes
65+
Any additional information that reviewers should know.

‎.github/dependabot.yml‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
version: 2
2+
updates:
3+
# Python dependencies (AI Backend)
4+
- package-ecosystem: "pip"
5+
directory: "/ai-backend"
6+
schedule:
7+
interval: "weekly"
8+
day: "monday"
9+
time: "09:00"
10+
open-pull-requests-limit: 5
11+
reviewers:
12+
- "vibing-ai"
13+
commit-message:
14+
prefix: "deps(ai-backend)"
15+
include: "scope"
16+
labels:
17+
- "dependencies"
18+
- "ai-backend"
19+
allow:
20+
- dependency-type: "direct"
21+
- dependency-type: "indirect"
22+
ignore:
23+
# Ignore major version updates for stable packages
24+
- dependency-name: "openai-agents"
25+
update-types: ["version-update:semver-major"]
26+
27+
# Node.js dependencies (Web Platform)
28+
- package-ecosystem: "npm"
29+
directory: "/web"
30+
schedule:
31+
interval: "weekly"
32+
day: "monday"
33+
time: "09:00"
34+
open-pull-requests-limit: 5
35+
reviewers:
36+
- "vibing-ai"
37+
commit-message:
38+
prefix: "deps(web)"
39+
include: "scope"
40+
labels:
41+
- "dependencies"
42+
- "web"
43+
allow:
44+
- dependency-type: "direct"
45+
- dependency-type: "indirect"
46+
ignore:
47+
# Ignore major version updates for React and Next.js
48+
- dependency-name: "react"
49+
update-types: ["version-update:semver-major"]
50+
- dependency-name: "react-dom"
51+
update-types: ["version-update:semver-major"]
52+
- dependency-name: "next"
53+
update-types: ["version-update:semver-major"]
54+
55+
# GitHub Actions
56+
- package-ecosystem: "github-actions"
57+
directory: "/"
58+
schedule:
59+
interval: "weekly"
60+
day: "monday"
61+
time: "09:00"
62+
open-pull-requests-limit: 3
63+
reviewers:
64+
- "vibing-ai"
65+
commit-message:
66+
prefix: "deps(actions)"
67+
include: "scope"
68+
labels:
69+
- "dependencies"
70+
- "github-actions"
71+
72+
# Docker
73+
- package-ecosystem: "docker"
74+
directory: "/ai-backend"
75+
schedule:
76+
interval: "weekly"
77+
day: "monday"
78+
time: "09:00"
79+
open-pull-requests-limit: 3
80+
reviewers:
81+
- "vibing-ai"
82+
commit-message:
83+
prefix: "deps(docker)"
84+
include: "scope"
85+
labels:
86+
- "dependencies"
87+
- "docker"

0 commit comments

Comments
 (0)