Initial commit
This commit is contained in:
iulian
commit
983cee0320
322 changed files with 57174 additions and 0 deletions
216
backup/first -fina app/README.md
Executable file
216
backup/first -fina app/README.md
Executable file
|
|
@ -0,0 +1,216 @@
|
|||
cat > README.md << 'EOF'
|
||||
# FINA - Personal Finance Tracker
|
||||
|
||||
<div align="center">
|
||||
<img src="app/static/images/fina-logo.png" alt="FINA Logo" width="120" height="120">
|
||||
|
||||
[](https://www.docker.com/)
|
||||
[](https://www.python.org/)
|
||||
[](https://flask.palletsprojects.com/)
|
||||
</div>
|
||||
|
||||
## Disclaimer
|
||||
|
||||
**USE AT YOUR OWN RISK**: This software is provided "as is", without warranty of any kind, express or implied. The authors and contributors assume no responsibility for any damages, data loss, security breaches, or other issues that may arise from using this software. Users are solely responsible for:
|
||||
|
||||
- Securing their deployment
|
||||
- Backing up their data
|
||||
- Configuring appropriate security measures
|
||||
- Complying with applicable data protection regulations
|
||||
|
||||
By using FINA, you acknowledge that you understand and accept these risks.
|
||||
|
||||
---
|
||||
|
||||
## About
|
||||
|
||||
FINA is a modern, self-hosted personal finance tracker built with Flask and Docker. Track your expenses, manage categories, visualize spending patterns, and keep your financial data completely under your control.
|
||||
|
||||
### Features
|
||||
|
||||
#### Core Features
|
||||
- ** Expense Tracking**: Organize expenses by custom categories
|
||||
- ** Visual Analytics**: Interactive pie and bar charts for spending insights
|
||||
- ** Tagging System**: Tag expenses for better organization
|
||||
- ** Receipt Management**: Upload and store receipt images/PDFs
|
||||
- ** Two-Factor Authentication**: Optional 2FA for enhanced security
|
||||
- ** Multi-User Support**: Admin can create and manage user accounts
|
||||
- ** Multi-Currency**: Support for USD, EUR, GBP, and RON
|
||||
- ** Import/Export**: CSV import and export functionality
|
||||
|
||||
#### Smart Features
|
||||
- **🔄 Recurring Expense Detection**: AI-powered detection of subscription patterns
|
||||
- **📅 Custom Subscriptions**: Create recurring expenses with flexible intervals
|
||||
- **💰 Budget Alerts**: Email notifications when spending exceeds category limits
|
||||
- **📊 Budget Tracking**: Set monthly budgets per category with visual status
|
||||
|
||||
#### Progressive Web App (PWA)
|
||||
- **📱 Install as App**: Add to home screen on mobile devices
|
||||
- **⚡ Offline Support**: Access core features without internet
|
||||
- **🔔 iOS Detection**: Smart prompts for iOS Safari users
|
||||
- **📲 Native Feel**: App-like experience on all platforms
|
||||
|
||||
#### Internationalization
|
||||
- **🌍 Multi-Language**: Full support for English, Romanian, and Spanish
|
||||
- **🔄 Language Switcher**: Easy toggle between languages
|
||||
- **📧 Localized Emails**: Budget alerts in user's preferred language
|
||||
|
||||
#### Design
|
||||
- ** Modern UI**: Beautiful dark-themed glassmorphism design
|
||||
- ** Mobile Responsive**: Works seamlessly on all devices
|
||||
- **🎨 Consistent Styling**: Cohesive design across all features
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Docker and Docker Compose installed
|
||||
- Ports 5001 and 6369 available on your host
|
||||
|
||||
### Installation
|
||||
|
||||
1. **Clone the repository:**
|
||||
git clone https://github.com/aiulian25/fina.git
|
||||
docker compose up -d
|
||||
|
||||
## Configuration
|
||||
|
||||
### Environment Variables
|
||||
|
||||
Create a `.env` file to customize your deployment:
|
||||
|
||||
```bash
|
||||
# Security
|
||||
SECRET_KEY=your-super-secret-key-change-this
|
||||
|
||||
# Redis
|
||||
REDIS_HOST=redis
|
||||
REDIS_PORT=6369
|
||||
|
||||
# Email (for budget alerts)
|
||||
MAIL_SERVER=smtp.gmail.com
|
||||
MAIL_PORT=587
|
||||
MAIL_USE_TLS=true
|
||||
MAIL_USERNAME=your-email@gmail.com
|
||||
MAIL_PASSWORD=your-app-password
|
||||
MAIL_DEFAULT_SENDER=noreply@fina.app
|
||||
|
||||
# Application
|
||||
APP_URL=http://localhost:5001
|
||||
```
|
||||
|
||||
**Email Configuration Notes:**
|
||||
- Budget alerts require SMTP configuration
|
||||
- For Gmail: Enable 2FA and create an [App Password](https://myaccount.google.com/apppasswords)
|
||||
- Other providers: SendGrid, Mailgun, Amazon SES, Outlook, etc.
|
||||
- See [Budget Alerts Documentation](docs/BUDGET_ALERTS.md) for details
|
||||
|
||||
**Access FINA:**
|
||||
- Open your browser to `http://localhost:5001`
|
||||
- Register your first user (automatically becomes admin)
|
||||
- Start tracking!
|
||||
|
||||
### Ports
|
||||
|
||||
- **5001**: Web application (can be changed in docker-compose.yml)
|
||||
- **6369**: Redis cache
|
||||
|
||||
## 📖 Usage
|
||||
|
||||
### First Time Setup
|
||||
|
||||
1. Register your account - first user becomes admin
|
||||
2. Go to Settings → Profile to set your currency
|
||||
3. (Optional) Enable 2FA in Settings → Security
|
||||
4. Create expense categories
|
||||
5. Start adding expenses!
|
||||
|
||||
### Admin Features
|
||||
|
||||
Admins can access User Management in Settings to:
|
||||
- Create managed user accounts
|
||||
- Edit user details and roles
|
||||
- Manage system users
|
||||
|
||||
### Data Management
|
||||
|
||||
- **Export**: Settings → Import/Export → Export to CSV
|
||||
- **Import**: Settings → Import/Export → Upload CSV file
|
||||
- **Backups**: Data persists in Docker volumes `fina-db` and `fina-uploads`
|
||||
|
||||
## Security Considerations
|
||||
|
||||
**IMPORTANT**: This application is designed for self-hosting. Please consider:
|
||||
|
||||
1. **Change the default SECRET_KEY** in production
|
||||
2. **Use HTTPS** with a reverse proxy (nginx, Caddy, Traefik)
|
||||
3. **Enable 2FA** for all users
|
||||
4. **Regular backups** of your data
|
||||
5. **Keep Docker images updated**
|
||||
6. **Restrict network access** to trusted devices only
|
||||
|
||||
### Recommended Production Setup
|
||||
|
||||
Start
|
||||
|
||||
docker compose up -d
|
||||
Stop
|
||||
|
||||
docker compose down
|
||||
View logs
|
||||
|
||||
docker compose logs -f web
|
||||
Restart
|
||||
|
||||
docker compose restart
|
||||
Update to latest
|
||||
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
- **[Budget Alerts Guide](docs/BUDGET_ALERTS.md)** - Setup email notifications and budget tracking
|
||||
- **[Security Audit](docs/SECURITY_AUDIT.md)** - Security features and best practices
|
||||
- **[PWA Features](docs/PWA.md)** - Progressive Web App installation and offline support
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Backend**: Python 3.11, Flask, SQLAlchemy, Flask-Mail
|
||||
- **Database**: SQLite
|
||||
- **Cache**: Redis
|
||||
- **Frontend**: Vanilla JavaScript, Chart.js
|
||||
- **PWA**: Service Worker, Web Manifest
|
||||
- **Security**: Flask-Login, Flask-WTF (CSRF), pyotp (2FA)
|
||||
- **Deployment**: Docker, Gunicorn
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please feel free to submit a Pull Request.
|
||||
|
||||
1. Fork the repository
|
||||
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
|
||||
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
|
||||
4. Push to the branch (`git push origin feature/AmazingFeature`)
|
||||
5. Open a Pull Request
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
- Built with using Flask and modern web technologies
|
||||
- Icons and design inspiration from various open-source projects
|
||||
|
||||
## Support
|
||||
|
||||
For issues, questions, or suggestions:
|
||||
- Open an issue on GitHub
|
||||
- Check existing documentation
|
||||
|
||||
---
|
||||
|
||||
**Remember**: Always back up your data and secure your deployment appropriately. This software handles sensitive financial information.
|
||||
# fina
|
||||
Loading…
Add table
Add a link
Reference in a new issue