feat: add comprehensive GitHub workflow and development tools
This commit is contained in:
89
README.md
Normal file
89
README.md
Normal file
@@ -0,0 +1,89 @@
|
||||
# Stiftung Application
|
||||
|
||||
A comprehensive Django-based foundation management system with modern features.
|
||||
|
||||
## 🌟 Features
|
||||
|
||||
- **Destinatär Management**: Track beneficiaries and their support
|
||||
- **Förderung System**: Manage grants and funding with enhanced search
|
||||
- **HelpBox System**: Editable info boxes with Markdown support on all creation pages
|
||||
- **PDF Exports**: Generate comprehensive reports
|
||||
- **Land Management**: Track properties and lease agreements
|
||||
- **Backup & Restore**: Automated backup system with UI
|
||||
- **User Management**: Role-based access control
|
||||
- **Audit Trail**: Track all changes
|
||||
|
||||
## 🆕 New Features (v2.0)
|
||||
|
||||
- ✅ **HelpBox System**: Interactive help on all "New" entity creation pages
|
||||
- ✅ **Central HelpBox Management**: Admin interface at `/help-box/admin/`
|
||||
- ✅ **Enhanced Förderung Search**: Improved search functionality
|
||||
- ✅ **Template Cleanup**: Automated orphaned recurring payment handling
|
||||
- ✅ **Bootstrap Layout Fixes**: Resolved grid alignment issues
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Development Setup
|
||||
|
||||
```bash
|
||||
# Clone repository
|
||||
git clone https://github.com/yourusername/stiftung-starter.git
|
||||
cd stiftung-starter
|
||||
|
||||
# Start development environment
|
||||
docker-compose up -d
|
||||
|
||||
# Create superuser
|
||||
docker-compose exec web python manage.py createsuperuser
|
||||
|
||||
# Access application
|
||||
open http://localhost:8000
|
||||
```
|
||||
|
||||
### Production Deployment
|
||||
|
||||
See [deployment documentation](deploy-production/MIGRATION_PLAN.md) for complete setup instructions.
|
||||
|
||||
## 📁 Project Structure
|
||||
|
||||
```
|
||||
stiftung-starter/
|
||||
├── app/ # Django application
|
||||
│ ├── core/ # Django project settings
|
||||
│ ├── stiftung/ # Main app
|
||||
│ │ ├── models.py # Data models (including HelpBox)
|
||||
│ │ ├── views.py # Views and API endpoints
|
||||
│ │ ├── admin.py # Django admin customization
|
||||
│ │ ├── templatetags/ # Custom template tags (help_tags)
|
||||
│ │ └── utils/ # Utility functions
|
||||
│ ├── templates/ # HTML templates
|
||||
│ │ └── stiftung/
|
||||
│ │ ├── help_box.html # HelpBox component
|
||||
│ │ └── *_form.html # Creation forms with help boxes
|
||||
│ └── requirements.txt # Python dependencies
|
||||
├── deploy-production/ # Production deployment files
|
||||
├── deploy-synology/ # Synology NAS deployment (legacy)
|
||||
└── docs/ # Documentation
|
||||
```
|
||||
|
||||
## 🛠️ Development Workflow
|
||||
|
||||
### 1. Feature Development
|
||||
|
||||
```bash
|
||||
# Create feature branch
|
||||
git checkout -b feature/your-feature-name
|
||||
|
||||
# Make your changes
|
||||
# ... edit files ...
|
||||
|
||||
# Test locally
|
||||
docker-compose up -d
|
||||
|
||||
# Commit changes
|
||||
git add .
|
||||
git commit -m "feat: add your feature description"
|
||||
|
||||
# Push to GitHub
|
||||
git push origin feature/your-feature-name
|
||||
```
|
||||
Reference in New Issue
Block a user