Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ShopTracker - Simple Inventory Management for Small Retailers

🎯 Overview

ShopTracker is a mobile application designed to digitize inventory management for small shopkeepers in emerging markets like Nepal. The app provides an intuitive, user-friendly interface for retailers to track their inventory with simple tap-based inputs, while generating valuable market insights for product companies.

🚀 Features

  • Simple Inventory Updates: Tap-based interface for quick sales and restocking
  • Pre-loaded Products: Common products popular in Nepal (Wai Wai, Coca Cola, etc.)
  • Real-time Analytics: Sales insights and inventory tracking
  • Offline Capability: Works without internet, syncs when connected
  • Market Intelligence: Aggregated data insights for B2B clients
  • Multi-language Support: Nepali and English interface

🏗️ Architecture

┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐
│  Flutter App    │◄──►│  Backend API     │◄──►│   Database      │
│  (Mobile UI)    │    │  (Flask/Python)  │    │  (SQLite/       │
│                 │    │                  │    │   PostgreSQL)   │
└─────────────────┘    └──────────────────┘    └─────────────────┘
         │                       │                       │
         │                       │                       │
         ▼                       ▼                       ▼
┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐
│   Simple UI     │    │ Analytics Engine │    │ Admin Dashboard │
│ (Tap to Update) │    │ (Data Processing)│    │ (Web Interface) │
└─────────────────┘    └──────────────────┘    └─────────────────┘

🛠️ Technology Stack

  • Frontend: Flutter 3.x (Dart)
  • Backend: Flask (Python 3.9+)
  • Database: SQLite (Development), PostgreSQL (Production)
  • Analytics: Pandas, NumPy
  • Admin Dashboard: React.js
  • Deployment: Docker, Google Cloud Run

📁 Project Structure

shoptracker/
├── mobile_app/           # Flutter mobile application
├── backend/              # Flask API server
├── admin_dashboard/      # React admin interface
├── database/             # Database schemas and migrations
├── docs/                 # Project documentation
├── tests/                # Test suites
├── deployment/           # Deployment configurations
└── README.md

🚀 Quick Start

Prerequisites

  • Flutter SDK 3.x
  • Python 3.9+
  • Node.js 16+
  • Git

Installation

  1. Clone the repository

    git clone https://github.com/your-username/shoptracker.git
    cd shoptracker
  2. Setup Backend

    cd backend
    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
    pip install -r requirements.txt
    python app.py
  3. Setup Mobile App

    cd mobile_app
    flutter pub get
    flutter run
  4. Setup Admin Dashboard

    cd admin_dashboard
    npm install
    npm start

📊 Development Roadmap

  • Phase 1: MVP with basic inventory tracking
  • Phase 2: Offline functionality and user authentication
  • Phase 3: Advanced analytics and B2B dashboard
  • Phase 4: AI-powered insights and regional expansion

🤝 Contributing

  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 file for details.

🙏 Acknowledgments

  • Built for small retailers in emerging markets
  • Inspired by the need for simple, accessible technology
  • Designed with love for the Nepali market

Made with ❤️ for small businesses in Nepal 🇳🇵 EOF

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages