- Fixed nginx 404 errors with enhanced file copying and fallback configuration - Added docker-compose.simple.yml for streamlined first-time deployment - Enhanced docker-compose.deploy-local.yml with detailed debugging and health checks - Improved nginx.deploy.conf with fallback pages and auto-refresh - Added comprehensive DEPLOYMENT_GUIDE.md with multiple deployment options - Created validate-deployment.sh script for environment validation - Updated container interface deployment documentation - Added DEPLOYMENT_STATUS.md summary of ready features Deployment improvements: - Enhanced container startup sequence with health checks - Detailed logging for troubleshooting file copying issues - Multiple deployment strategies for different use cases - Fallback nginx configuration prevents 404 errors during startup - Auto-refresh functionality for seamless user experience Ready for production deployment via container interfaces or command line.
205 lines
No EOL
8.3 KiB
Markdown
205 lines
No EOL
8.3 KiB
Markdown
# 🎯 Etsy Finance Tracker with Comprehensive Profit Analysis
|
|
|
|
A powerful business intelligence tool designed specifically for Etsy sellers to track orders, analyze profit margins, manage expenses, and gain deep insights into their business performance.
|
|
|
|
## ✨ Key Features
|
|
|
|
### 📊 **Advanced Profit Analysis Dashboard**
|
|
- **Real-time Profit Tracking**: Monitor profit margins across all products and time periods
|
|
- **Cost Breakdown Analysis**: Detailed breakdown of material costs, Etsy fees, shipping, and other expenses
|
|
- **Interactive Charts**: Visual representations of revenue, costs, and profit trends
|
|
- **Product Performance Metrics**: Identify your most and least profitable products
|
|
- **Time-based Analysis**: Compare performance across different periods
|
|
|
|
### 🏪 **Complete Business Management**
|
|
- **Order Tracking**: Comprehensive order management with status updates
|
|
- **Product Catalog**: Full product database with variants, pricing, and inventory
|
|
- **Customer Management**: Track customer data, purchase history, and preferences
|
|
- **Expense Management**: Record and categorize all business expenses
|
|
- **Financial Reporting**: Generate P&L statements and tax-ready reports
|
|
|
|
### 📈 **Smart Analytics & Insights**
|
|
- **Revenue Forecasting**: Predict future revenue based on historical data
|
|
- **Seasonal Analysis**: Understand seasonal trends in your business
|
|
- **Customer Lifetime Value**: Track repeat customers and their total value
|
|
- **ROI Analysis**: Measure return on investment for marketing and materials
|
|
|
|
### 🔄 **Automated Data Processing**
|
|
- **CSV Import**: Bulk import orders and transactions from Etsy statements
|
|
- **PDF Processing**: Extract data from Etsy payment receipts and statements
|
|
- **Smart Product Matching**: Automatically match imported data to your product catalog
|
|
- **Bulk Operations**: Process hundreds of orders and transactions efficiently
|
|
|
|
## 🚀 Quick Start Deployment
|
|
|
|
### Option 1: Container Interface (Docker Desktop, Portainer)
|
|
**Recommended for most users**
|
|
|
|
1. **Download Files**: Clone or download this repository
|
|
2. **Choose Deployment File**:
|
|
- `docker-compose.simple.yml` - Best for first-time users
|
|
- `docker-compose.deploy-local.yml` - Enhanced debugging
|
|
- `docker-compose.deploy.yml` - Pre-built images
|
|
3. **Import in Your Container Tool**:
|
|
- Docker Desktop: Compose tab → Import
|
|
- Portainer: Stacks → Add stack → Upload
|
|
4. **Deploy and Access**: http://localhost:8081
|
|
|
|
📖 **Detailed Guide**: See `DEPLOYMENT_GUIDE.md` for comprehensive instructions
|
|
|
|
### Option 2: Command Line (If Docker is installed)
|
|
```bash
|
|
# Clone repository
|
|
git clone https://github.com/your-username/etsy-finance-tracker
|
|
cd etsy-finance-tracker
|
|
|
|
# Deploy with local build
|
|
docker-compose -f docker-compose.deploy-local.yml up --build
|
|
|
|
# Access application
|
|
open http://localhost:8081
|
|
```
|
|
|
|
### Option 3: Development Setup
|
|
```bash
|
|
# Install dependencies
|
|
npm install
|
|
cd client && npm install
|
|
cd ../server && npm install
|
|
|
|
# Start development servers
|
|
npm run dev # Starts both frontend and backend
|
|
```
|
|
|
|
## 🛠️ Validation & Troubleshooting
|
|
|
|
Run the validation script to check your environment:
|
|
```bash
|
|
./validate-deployment.sh
|
|
```
|
|
|
|
This will check Docker availability, required files, port conflicts, and disk space.
|
|
|
|
## 📁 Project Structure
|
|
|
|
```
|
|
etsy-finance-tracker/
|
|
├── 🐳 Docker Configuration
|
|
│ ├── Dockerfile # Multi-stage production build
|
|
│ ├── docker-compose.simple.yml # Simple deployment (recommended)
|
|
│ ├── docker-compose.deploy-local.yml # Enhanced local build
|
|
│ ├── docker-compose.deploy.yml # Pre-built images
|
|
│ └── nginx.deploy.conf # Nginx reverse proxy config
|
|
│
|
|
├── 🎯 Frontend (React + TypeScript)
|
|
│ ├── client/src/
|
|
│ │ ├── pages/ # Main application pages
|
|
│ │ │ ├── Dashboard.tsx # KPI overview dashboard
|
|
│ │ │ ├── ProfitAnalysis.tsx # Advanced profit analytics
|
|
│ │ │ ├── Orders.tsx # Order management
|
|
│ │ │ ├── Products.tsx # Product catalog
|
|
│ │ │ ├── Customers.tsx # Customer management
|
|
│ │ │ └── Expenses.tsx # Expense tracking
|
|
│ │ ├── components/ # Reusable UI components
|
|
│ │ ├── store/ # Redux state management
|
|
│ │ └── utils/ # Business logic utilities
|
|
│
|
|
├── ⚙️ Backend (Node.js + Express)
|
|
│ ├── server/src/
|
|
│ │ ├── controllers/ # API route handlers
|
|
│ │ ├── models/ # Data models
|
|
│ │ ├── routes/ # API endpoints
|
|
│ │ └── middleware/ # Authentication & validation
|
|
│
|
|
├── 📊 Data Processing
|
|
│ ├── data/csv/ # CSV import files
|
|
│ ├── data/pdf/ # PDF processing files
|
|
│ └── utils/ # Data processing utilities
|
|
│
|
|
└── 📚 Documentation
|
|
├── DEPLOYMENT_GUIDE.md # Comprehensive deployment guide
|
|
├── CONTAINER_INTERFACE_DEPLOYMENT.md # GUI deployment instructions
|
|
├── DOCKER_DEPLOYMENT.md # Docker-specific guide
|
|
└── GITHUB_CONTAINER_REGISTRY.md # CI/CD documentation
|
|
```
|
|
|
|
## 💼 Business Intelligence Features
|
|
|
|
### Profit Analysis Dashboard
|
|
- **Gross Margin Analysis**: Calculate true profit after all costs
|
|
- **Product Profitability Ranking**: See which products make the most money
|
|
- **Time-Series Profit Tracking**: Monitor profit trends over time
|
|
- **Cost Center Analysis**: Understand where your money goes
|
|
- **Break-even Analysis**: Calculate break-even points for products
|
|
|
|
### Financial Reporting
|
|
- **Monthly P&L Statements**: Automated profit and loss reports
|
|
- **Tax Preparation**: Export tax-ready financial summaries
|
|
- **Expense Categorization**: Organize expenses for accounting
|
|
- **Revenue Recognition**: Track when revenue is actually earned
|
|
- **Cash Flow Analysis**: Monitor money in vs money out
|
|
|
|
### Operational Insights
|
|
- **Inventory Optimization**: Track stock levels and reorder points
|
|
- **Customer Segmentation**: Identify your best customers
|
|
- **Seasonal Planning**: Prepare for busy and slow periods
|
|
- **Marketing ROI**: Measure effectiveness of marketing spend
|
|
- **Pricing Strategy**: Optimize prices based on profit analysis
|
|
|
|
## 🔧 Technical Stack
|
|
|
|
- **Frontend**: React 18, TypeScript, Tailwind CSS, Redux Toolkit
|
|
- **Backend**: Node.js, Express, TypeScript
|
|
- **Database**: MongoDB (containerized)
|
|
- **Charts**: Chart.js for data visualization
|
|
- **Deployment**: Docker with nginx reverse proxy
|
|
- **CI/CD**: GitHub Actions with container registry
|
|
- **Testing**: Jest, React Testing Library
|
|
|
|
## 📊 Data Sources Supported
|
|
|
|
- **Etsy CSV Exports**: Transaction summaries, payment reports
|
|
- **Etsy PDF Statements**: Monthly and annual statements
|
|
- **Manual Entry**: Direct data input through the interface
|
|
- **Bulk Import**: CSV templates for batch operations
|
|
- **API Integration**: Extensible for future Etsy API integration
|
|
|
|
## 🔐 Security & Privacy
|
|
|
|
- JWT-based authentication
|
|
- Input validation and sanitization
|
|
- HTTPS enforcement in production
|
|
- GDPR-compliant data handling
|
|
- Secure file upload processing
|
|
- Rate limiting on API endpoints
|
|
|
|
## 📈 Performance Features
|
|
|
|
- **Lazy Loading**: Components load as needed
|
|
- **Data Caching**: Efficient data retrieval and storage
|
|
- **Optimized Queries**: Fast database operations
|
|
- **Progressive Web App**: Works offline when possible
|
|
- **Responsive Design**: Works on all device sizes
|
|
|
|
## 🤝 Contributing
|
|
|
|
1. Fork the repository
|
|
2. Create a feature branch
|
|
3. Make your changes
|
|
4. Add tests if applicable
|
|
5. Submit a pull request
|
|
|
|
## 📄 License
|
|
|
|
This project is licensed under the MIT License - see the LICENSE file for details.
|
|
|
|
## 🆘 Support & Documentation
|
|
|
|
- **Quick Start**: Follow deployment instructions above
|
|
- **Detailed Guides**: Check the documentation files
|
|
- **Troubleshooting**: Run `./validate-deployment.sh`
|
|
- **Issues**: Open GitHub issues for bugs or feature requests
|
|
|
|
---
|
|
|
|
**🎉 Transform your Etsy business with data-driven insights and comprehensive profit analysis!** |