Skip to content

Commit 0c54557

Browse files
Create and configure GitHub files
Create standard files for the repository, including `CONTRIBUTING.md`, `SECURITY.md`, `CODE_OF_CONDUCT.md`, `CHANGELOG.md`, `LICENSE`, and `.env.example`. Also, add issue and pull request templates.
1 parent 5a9d198 commit 0c54557

16 files changed

Lines changed: 676 additions & 10 deletions

.env.example

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
# Firebase Configuration
3+
VITE_FIREBASE_API_KEY=your_api_key_here
4+
VITE_FIREBASE_AUTH_DOMAIN=your_auth_domain_here
5+
VITE_FIREBASE_PROJECT_ID=your_project_id_here
6+
VITE_FIREBASE_STORAGE_BUCKET=your_storage_bucket_here
7+
VITE_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id_here
8+
VITE_FIREBASE_APP_ID=your_app_id_here
9+
VITE_FIREBASE_MEASUREMENT_ID=your_measurement_id_here
10+
11+
# App Configuration
12+
VITE_APP_URL=https://your-domain.com
13+
VITE_SHORT_LINK_BASE=https://your-domain.com/s
14+
VITE_API_BASE_URL=https://api.your-domain.com
15+
16+
# Feature Flags
17+
VITE_ENABLE_ANALYTICS=true
18+
VITE_ENABLE_ERROR_REPORTING=true
19+
20+
# Third-party Services
21+
VITE_STRIPE_PUBLIC_KEY=your_stripe_public_key_here

.gitattributes

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
2+
* text=auto eol=lf
3+
4+
# Graphics
5+
*.png binary
6+
*.jpg binary
7+
*.jpeg binary
8+
*.gif binary
9+
*.ico binary
10+
*.svg text
11+
12+
# Archives
13+
*.zip binary
14+
*.gz binary
15+
*.tar binary
16+
17+
# Documentation
18+
*.md text
19+
*.txt text
20+
*.pdf binary
21+
22+
# Configs
23+
*.json text
24+
*.yml text
25+
*.yaml text
26+
*.toml text
27+
28+
# Source code
29+
*.js text
30+
*.ts text
31+
*.tsx text
32+
*.jsx text
33+
*.css text
34+
*.scss text
35+
*.html text
36+
37+
# Lock files
38+
package-lock.json linguist-generated=true
39+
yarn.lock linguist-generated=true

.github/CODEOWNERS

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
# This file defines individuals or teams that are responsible for code in the repository.
3+
# See: https://help.github.com/articles/about-codeowners/
4+
5+
# These owners will be the default owners for everything in the repo
6+
* @your-username
7+
8+
# Specific ownership for critical components
9+
/src/lib/firebase.ts @your-username
10+
/src/hooks/useAuth.tsx @your-username
11+
/src/components/ErrorBoundary.tsx @your-username
12+
13+
# Documentation
14+
*.md @your-username
15+
docs/ @your-username

.github/FUNDING.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
# These are supported funding model platforms
3+
4+
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
5+
patreon: # Replace with a single Patreon username
6+
open_collective: # Replace with a single Open Collective username
7+
ko_fi: # Replace with a single Ko-fi username
8+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
9+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
10+
liberapay: # Replace with a single Liberapay username
11+
issuehunt: # Replace with a single IssueHunt username
12+
otechie: # Replace with a single Otechie username
13+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
14+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
2+
---
3+
name: Bug report
4+
about: Create a report to help us improve
5+
title: '[BUG] '
6+
labels: 'bug'
7+
assignees: ''
8+
9+
---
10+
11+
## 🐛 Bug Description
12+
A clear and concise description of what the bug is.
13+
14+
## 🔄 Steps To Reproduce
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+
## 📱 Environment
24+
- **Device**: [e.g. iPhone 14, MacBook Pro]
25+
- **OS**: [e.g. iOS 16.5, Windows 11]
26+
- **Browser**: [e.g. Chrome 114, Safari 16]
27+
- **App Version**: [e.g. 1.0.2]
28+
29+
## 📷 Screenshots
30+
If applicable, add screenshots to help explain your problem.
31+
32+
## 📊 Error Details
33+
```
34+
Paste any error messages, console logs, or stack traces here.
35+
```
36+
37+
## ℹ️ Additional Context
38+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: 💬 Discord Community
5+
url: https://discord.gg/refspring
6+
about: Ask questions and engage with the RefSpring community
7+
- name: 📧 Email Support
8+
url: mailto:support@refspring.com
9+
about: Contact support directly for urgent issues
10+
- name: 📚 Documentation
11+
url: https://github.com/your-username/refspring/wiki
12+
about: Check out our documentation for guides and FAQs
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
---
3+
name: Feature request
4+
about: Suggest an idea for this project
5+
title: '[FEATURE] '
6+
labels: 'enhancement'
7+
assignees: ''
8+
9+
---
10+
11+
## 🔍 Problem Statement
12+
A clear and concise description of what problem this feature would solve. Ex. I'm always frustrated when [...]
13+
14+
## 🎯 Proposed Solution
15+
A clear and concise description of what you want to happen.
16+
17+
## 🔄 Alternative Solutions
18+
A clear and concise description of any alternative solutions or features you've considered.
19+
20+
## 📊 Success Metrics
21+
How would we measure the success of this feature?
22+
23+
## 📄 User Stories
24+
As a [type of user], I want [goal] so that [benefit].
25+
26+
## 🎨 Design Ideas
27+
Any mockups, wireframes, or design ideas you have (optional).
28+
29+
## ℹ️ Additional Context
30+
Add any other context or screenshots about the feature request here.

.github/REPOSITORY_DETAILS

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
# RefSpring Repository Configuration
3+
4+
## 📝 Short Description
5+
Next-generation affiliate platform with real-time analytics, smart tracking, and fraud protection
6+
7+
## 🏷️ Topics
8+
affiliate-marketing react typescript firebase analytics tracking tailwindcss shadcn-ui react-query internationalization error-handling responsive-design
9+
10+
## 🌐 Website
11+
https://refspring.com
12+
13+
## 🛠️ Development Status
14+
Active development

.github/pull_request_template.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
2+
## 📝 Description
3+
Please include a summary of the change and which issue is fixed. Include relevant motivation and context.
4+
5+
Fixes # (issue number)
6+
7+
## 🧪 Type of change
8+
Please delete options that are not relevant.
9+
10+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
11+
- [ ] ✨ New feature (non-breaking change which adds functionality)
12+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
13+
- [ ] 📚 Documentation update
14+
- [ ] 🧹 Code refactoring (no functional changes)
15+
- [ ] 🔧 Other (please describe):
16+
17+
## 🔍 How Has This Been Tested?
18+
Please describe the tests that you ran to verify your changes. Provide instructions to reproduce.
19+
20+
- [ ] Test A
21+
- [ ] Test B
22+
23+
## 📷 Screenshots (if applicable)
24+
Add screenshots to help explain your PR.
25+
26+
## ✅ Checklist
27+
- [ ] My code follows the style guidelines of this project
28+
- [ ] I have performed a self-review of my own code
29+
- [ ] I have commented my code, particularly in hard-to-understand areas
30+
- [ ] I have made corresponding changes to the documentation
31+
- [ ] My changes generate no new warnings
32+
- [ ] I have added tests that prove my fix is effective or that my feature works
33+
- [ ] New and existing unit tests pass locally with my changes
34+
- [ ] Any dependent changes have been merged and published
35+
- [ ] I have updated the CHANGELOG.md

.github/workflows/ci.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
2+
name: CI
3+
4+
on:
5+
push:
6+
branches: [ main, develop ]
7+
pull_request:
8+
branches: [ main, develop ]
9+
10+
jobs:
11+
build:
12+
runs-on: ubuntu-latest
13+
14+
strategy:
15+
matrix:
16+
node-version: [18.x]
17+
18+
steps:
19+
- uses: actions/checkout@v3
20+
21+
- name: Use Node.js ${{ matrix.node-version }}
22+
uses: actions/setup-node@v3
23+
with:
24+
node-version: ${{ matrix.node-version }}
25+
cache: 'npm'
26+
27+
- name: Install dependencies
28+
run: npm ci
29+
30+
- name: Check linting
31+
run: npm run lint || echo "Linting not configured yet"
32+
33+
- name: Type checking
34+
run: npm run typecheck || npm run type-check || echo "Type checking not configured yet"
35+
36+
- name: Build
37+
run: npm run build
38+
39+
# Uncomment when tests are implemented
40+
# - name: Run tests
41+
# run: npm test

0 commit comments

Comments
 (0)