IBM Hackathon GitHub Project Template

This GitHub project template is for IBM Hackathon projects. It includes pre-configured security files to help prevent accidental credential commits and potential account suspension during the hackathon.

🚀 Quick Start

1. Use this template to create your project:

   • Click "Use this template" button above
   • Select your hackathon organization as the owner
   • Name your repository
   • Ensure "Private" is selected
   • Click "Create repository from template"

2. Clone your new repository:

   git clone https://github.com/HACKATHON-ORG/your-repo-name.git
   cd your-repo-name

3. Set up environment variables:

   # Copy the example file
   cp .env.example .env
   
   # Edit .env with your actual credentials
   # Use your preferred editor (nano, vim, code, etc.)
   nano .env

4. Verify .gitignore is working:

   # This should NOT show .env file
   git status
   
   # This should confirm .env is ignored
   git check-ignore -v .env

5. Start developing!

🔒 Security Features

This template includes:

• .gitignore - Prevents committing credentials and live session files
• .bobignore - Prevents AI assistants from logging credentials
• .env.example - Template for your environment variables
• SECURITY.md - Comprehensive security guidelines

📋 Before Every Commit

Always run this checklist:

• Reviewed git diff for sensitive data
• No hardcoded API keys or passwords
• .env file is NOT in staged changes
• No files with "credential" or "secret" in name
• Used environment variables for all credentials

🆘 Need Help?

• Read SECURITY.md for detailed guidelines
• Contact hackathon support through mentor channel
• Ask in the hackathon Slack workspace

---

Remember: Security is everyone's responsibility. When in doubt, ask for help!