Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/InnoDev69/StockManager/llms.txt

Use this file to discover all available pages before exploring further.

StockManager is an open-source inventory and sales management system designed for small to medium businesses. It runs as a native desktop application powered by PyWebView, with a Flask + SQLite backend, a real-time notification system, and a fully documented REST API for integrations.

Introduction

Understand what StockManager is, how it works, and when to use it.

Quickstart

Run StockManager locally and make your first API call in minutes.

API Reference

Explore all REST endpoints — products, sales, users, metrics, and more.

Core Features

Inventory management, sales tracking, analytics dashboard, and CSV import.

What’s inside

Inventory Control

Add, update, and disable products. Barcode support, expiration dates, and min-stock alerts.

Sales Tracking

Register single or bulk sales, track payment methods, and edit historical records.

Analytics

KPIs, revenue trends, top products, heatmaps, and inventory forecasts.

Notifications

Real-time SSE-powered alerts for low stock, sales events, and admin actions.

CSV Import

Bulk-load product catalogs from CSV files directly into the inventory.

User Management

Role-based access control with root, admin, and vendor roles.

Getting started

1

Install dependencies

Clone the repository and install Python requirements.
git clone https://github.com/InnoDev69/StockManager.git
cd StockManager
pip install -r requirements.txt
2

Configure environment

Create a .env file with your Flask secret key and optional email settings.
echo "FLASK_SECRET_KEY=your-secret-key" > .env
3

Run the app

Launch in development mode (browser) or as a desktop window.
# Development mode (browser)
python run-dev.py

# Desktop mode (PyWebView window)
python main.py
4

Log in

Open http://127.0.0.1:5000 and sign in with the default root credentials created on first run.
For a complete walkthrough including environment variables and the default root account, see the Installation guide.

Build docs developers (and LLMs) love