docs/GIT_PUSH_GUIDE.md

Push Code to GitHub - Steps

Option 1: Push to Existing GitHub Repository

If you already have a repository on GitHub, follow these steps:

1. On GitHub, create a new repository:

• Go to https://github.com/new
• Fill in repository name: RAG-Capstone-Project (or your preferred name)
• Add description: "Retrieval-Augmented Generation (RAG) system with TRACE evaluation metrics"
• Choose: Public or Private
• DO NOT initialize with README, .gitignore, or license (we already have these)
• Click "Create repository"

2. In PowerShell, add remote and push:

cd "D:\CapStoneProject\RAG Capstone Project"

# Add remote (replace YOUR_USERNAME and REPO_NAME)
git remote add origin https://github.com/YOUR_USERNAME/RAG-Capstone-Project.git

# Rename branch to main (optional but recommended)
git branch -M main

# Push to GitHub
git push -u origin main

3. When prompted, enter your GitHub credentials:

• Username: Your GitHub username
• Password: Your GitHub personal access token (not your password)
• Generate token: https://github.com/settings/tokens

---

Option 2: If You Don't Have GitHub Account Yet

1. Go to https://github.com/join
2. Create a free account
3. Follow Option 1 steps above

---

Troubleshooting

If you get "fatal: remote origin already exists":

git remote remove origin
git remote add origin https://github.com/YOUR_USERNAME/RAG-Capstone-Project.git
git push -u origin main

If you get authentication error:

1. Generate Personal Access Token:
   • Go to https://github.com/settings/tokens
   • Click "Generate new token (classic)"
   • Select: repo, write:packages
   • Copy the token
2. Use token instead of password when prompted

If you have SSH key setup:

git remote add origin git@github.com:YOUR_USERNAME/RAG-Capstone-Project.git
git push -u origin main

---

What Will Be Pushed

✅ All Python source files:

• streamlit_app.py - Main Streamlit UI
• llm_client.py - Groq LLM integration
• vector_store.py - ChromaDB management
• embedding_models.py - 8 embedding models
• trace_evaluator.py - TRACE metrics
• dataset_loader.py - RAGBench dataset loading
• chunking_strategies.py - 4 chunking strategies
• And more...

✅ Documentation:

• README.md - Project overview
• SETUP.md - Installation guide
• ENHANCEMENTS.md - Recent enhancements
• .env.example - Environment template

✅ Configuration:

• requirements.txt - All dependencies
• Dockerfile - Docker containerization
• docker-compose.yml - Multi-container setup
• Procfile - Heroku deployment

❌ Excluded (in .gitignore):

• venv/ - Virtual environment
• chroma_db/ - ChromaDB data
• .env - API keys (keep local!)
• __pycache__/ - Python cache
• .streamlit/ - Streamlit config

---

Next Steps After Pushing

1. Add a GitHub Actions workflow (optional):

   • Automated testing
   • Code quality checks
   • Deployment automation

2. Set up branch protection:

   • Require pull request reviews
   • Enforce status checks

3. Add GitHub Pages documentation:

   • Host project documentation
   • API documentation
   • Evaluation results

4. Setup CI/CD:

   • Test on every push
   • Deploy to Heroku/Cloud Run

---

Commands Summary

# Navigate to project
cd "D:\CapStoneProject\RAG Capstone Project"

# Configure git
git config user.email "your_email@example.com"
git config user.name "Your Name"

# Add remote (replace placeholders)
git remote add origin https://github.com/YOUR_USERNAME/RAG-Capstone-Project.git

# Rename branch to main
git branch -M main

# Push to GitHub
git push -u origin main

# Verify
git remote -v
git log --oneline

---

Share the GitHub URL with your team:

https://github.com/YOUR_USERNAME/RAG-Capstone-Project

Let me know when you have your GitHub username ready, and I can help you complete the push!