SuriRaja commited on
Commit
decab75
·
1 Parent(s): b54da4e

Add required README config for Hugging Face

Browse files
Files changed (1) hide show
  1. README.md +9 -176
README.md CHANGED
@@ -1,178 +1,11 @@
1
- # SETA Smart Inventory
2
-
3
- A mobile-first inventory and customer engagement app designed for Secunderabad Electrical Trade Associations (SETA) businesses.
4
-
5
- ## 🌟 Features
6
-
7
- ### 📦 Inventory Management
8
- - **Product Management**: Add, edit, and track electrical products with HSN codes, warranties, and pricing
9
- - **Barcode Scanning**: Quick stock updates using mobile camera or manual entry
10
- - **Smart Alerts**: Low stock, out of stock, and dead stock notifications
11
- - **Multi-location Support**: Track inventory across different locations
12
-
13
- ### 👥 Customer Relationship Management
14
- - **Customer Profiles**: Manage customer details with GSTIN, contact info, and purchase history
15
- - **Customer Segmentation**: Retail, Contractor, and Bulk customer types
16
- - **Engagement Tracking**: Monitor customer activity and identify at-risk customers
17
- - **Tiered Pricing**: Different pricing based on customer type
18
-
19
- ### 💬 WhatsApp Integration
20
- - **Order Processing**: Receive and process orders directly from WhatsApp
21
- - **Auto-invoicing**: Generate GST-compliant invoices from WhatsApp orders
22
- - **Customer Communication**: Manage conversations and order status updates
23
- - **Catalog Sharing**: Share product catalogs via WhatsApp
24
-
25
- ### 🤖 AI Analytics
26
- - **Demand Forecasting**: AI-powered sales predictions
27
- - **Churn Risk Analysis**: Identify customers at risk of leaving
28
- - **Inventory Optimization**: Smart reorder recommendations
29
- - **Performance Insights**: Top-selling products and trends
30
-
31
- ### 💰 Finance Management
32
- - **GST Compliance**: Generate GST-compliant invoices and returns
33
- - **Customer Ledger**: Track payments, outstanding amounts, and credit limits
34
- - **Financial Reports**: Revenue, profit, and tax analysis
35
- - **Payment Tracking**: Monitor payment status and overdue accounts
36
-
37
- ### 📊 Reports & Analytics
38
- - **Sales Reports**: Comprehensive sales analysis and trends
39
- - **Inventory Reports**: Stock levels, movements, and valuation
40
- - **Customer Analytics**: Behavior and engagement metrics
41
- - **Financial Summaries**: Revenue, profit, and compliance reports
42
-
43
- ## 🚀 Technology Stack
44
-
45
- - **Frontend**: Next.js 14 with TypeScript
46
- - **Styling**: Tailwind CSS with shadcn/ui components
47
- - **Charts**: Recharts for data visualization
48
- - **Icons**: Lucide React
49
- - **Mobile-First**: Responsive design optimized for mobile devices
50
-
51
- ## 📱 Mobile Optimization
52
-
53
- - **Touch-Friendly**: Optimized for touch interactions
54
- - **Responsive Design**: Works seamlessly on mobile, tablet, and desktop
55
- - **Fast Loading**: Optimized for mobile networks
56
- - **Offline Ready**: Can be enhanced with PWA features
57
-
58
- ## 🛠️ Installation
59
-
60
- 1. **Clone the repository**
61
- \`\`\`bash
62
- git clone <repository-url>
63
- cd seta-smart-inventory
64
- \`\`\`
65
-
66
- 2. **Install dependencies**
67
- \`\`\`bash
68
- npm install
69
- \`\`\`
70
-
71
- 3. **Run development server**
72
- \`\`\`bash
73
- npm run dev
74
- \`\`\`
75
-
76
- 4. **Build for production**
77
- \`\`\`bash
78
- npm run build
79
- \`\`\`
80
-
81
- ## 📦 Static Deployment
82
-
83
- This app is configured for static export and can be deployed to any static hosting service:
84
-
85
- \`\`\`bash
86
- # Build static version
87
- npm run build
88
-
89
- # The 'out' folder contains all static files
90
- \`\`\`
91
-
92
- ### Deployment Options:
93
- - **Vercel**: Connect GitHub repository for automatic deployment
94
- - **Netlify**: Drag and drop the 'out' folder
95
- - **GitHub Pages**: Push 'out' contents to gh-pages branch
96
- - **Any Static Host**: Upload 'out' folder contents
97
-
98
- ## 🔧 Configuration
99
-
100
- ### Environment Variables
101
- For production deployment, add environment variables with `NEXT_PUBLIC_` prefix:
102
-
103
- \`\`\`bash
104
- NEXT_PUBLIC_SALESFORCE_API_URL=https://your-salesforce-instance.com
105
- NEXT_PUBLIC_WHATSAPP_API_URL=https://your-whatsapp-api.com
106
- \`\`\`
107
-
108
- ### Salesforce Integration
109
- To connect with Salesforce:
110
- 1. Set up Salesforce Connected App
111
- 2. Configure OAuth settings
112
- 3. Add API endpoints to environment variables
113
- 4. Implement client-side API calls
114
-
115
- ## 📋 Project Structure
116
-
117
- \`\`\`
118
- seta-smart-inventory/
119
- ├── app/ # Next.js app directory
120
- │ ├── analytics/ # AI Analytics pages
121
- │ ├── customers/ # Customer management
122
- │ ├── finance/ # Financial management
123
- │ ├── inventory/ # Inventory management
124
- │ │ ├── alerts/ # Stock alerts
125
- │ │ └── scanner/ # Barcode scanner
126
- │ ├── reports/ # Reports and analytics
127
- │ ├── whatsapp/ # WhatsApp integration
128
- │ ├── globals.css # Global styles
129
- │ ├── layout.tsx # Root layout
130
- │ └── page.tsx # Dashboard
131
- ├── components/ # Reusable components
132
- │ ├── ui/ # shadcn/ui components
133
- │ └── app-sidebar.tsx # Main navigation
134
- ├── lib/ # Utility functions
135
- ├── public/ # Static assets
136
- ├── next.config.mjs # Next.js configuration
137
- ├── tailwind.config.js # Tailwind configuration
138
- └���─ package.json # Dependencies
139
- \`\`\`
140
-
141
- ## 🎯 Demo Data
142
-
143
- The app includes comprehensive mock data for demonstration:
144
- - **Products**: MCBs, LED panels, cables, switches, distribution panels
145
- - **Customers**: Various customer types with realistic data
146
- - **Orders**: Sample WhatsApp orders and invoices
147
- - **Analytics**: AI insights and forecasting data
148
-
149
- ## 🔮 Future Enhancements
150
-
151
- - **Real Salesforce Integration**: Connect with actual Salesforce CRM
152
- - **WhatsApp Business API**: Live WhatsApp integration
153
- - **Real Barcode Scanning**: Camera-based barcode scanning
154
- - **PWA Features**: Offline functionality and app installation
155
- - **Push Notifications**: Real-time alerts and updates
156
- - **Multi-language Support**: Hindi and Telugu language options
157
-
158
- ## 📄 License
159
-
160
- This project is licensed under the MIT License.
161
-
162
- ## 🤝 Contributing
163
-
164
- 1. Fork the repository
165
- 2. Create a feature branch
166
- 3. Make your changes
167
- 4. Submit a pull request
168
-
169
- ## 📞 Support
170
-
171
- For support and questions, please contact the development team or create an issue in the repository.
172
-
173
  ---
174
 
175
- **Built with ❤️ for SETA businesses**
176
- \`\`\`
177
-
178
- Finally, let me create a simple build script:
 
1
+ ---
2
+ title: SETA Smart Inventory
3
+ emoji: 🧾
4
+ colorFrom: blue
5
+ colorTo: indigo
6
+ sdk: static
7
+ app_file: index.html
8
+ pinned: false
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  ---
10
 
11
+ A static version of the SETA Smart Inventory App exported from Next.js and deployed via Hugging Face Spaces.