DEPLOYMENT.md

Deployment Guide

Pre-Push Checklist

Before pushing to a public repository, ensure:

1. ✅ No personal file paths (use relative paths)
2. ✅ No API keys or secrets in code
3. ✅ .env.example provided instead of .env
4. ✅ __pycache__ directories excluded
5. ✅ Generic author information in setup.py
6. ✅ Documentation updated to English
7. ✅ Test files and personal data removed

Git Configuration

If you need to change Git author information:

# Set generic author for this repository
git config user.name "Safety Tool Contributors"
git config user.email "safety-tool@example.com"

First Time Setup

1. Fork or create a new repository on GitHub
2. Update the repository URL in setup.py
3. Add the remote:

   git remote add origin https://github.com/YOUR_USERNAME/safety-tool.git

4. Push the code:

   git push -u origin main

Security Notes

• Never commit real API keys
• Use environment variables for sensitive data
• Review all commits before pushing
• Consider using git-secrets or similar tools

License

This project is released under the MIT License. See LICENSE file for details.