Stock Management System Requirements Document

1. Introduction

The Stock Management project aims to develop a simple, production-ready Android application tailored for small and medium kirana shops in India. The application is designed to function entirely offline, providing an intuitive interface for shopkeepers with minimal smartphone experience.

2. System Overview

The Stock Management application will facilitate the management of sales, purchases, stock, and customer credit (udhar) for kirana shops. It will feature a straightforward user interface with essential functionalities to ensure ease of use and efficiency in daily operations.

Key Features:

• Offline functionality with SQLite database
• Simple and intuitive UI with large buttons and rounded cards
• Support for Hindi and English languages
• Automatic stock and profit calculations
• Backup and restore capabilities

3. Functional Requirements as Story Points

• As a Shopkeeper, I should be able to view today's sales, profit, and low stock products on the Home tab.
• As a Shopkeeper, I should be able to add new products with details such as name, type, stock, purchase price, selling price, and minimum stock.
• As a Shopkeeper, I should be able to input product quantities naturally (e.g., 50 kg, 250 gram) and have the app automatically detect and convert units.
• As a Shopkeeper, I should be able to search for products, input quantities, and save sales, which will automatically reduce stock and calculate profit.
• As a Shopkeeper, I should be able to record purchases with product details, supplier name, quantity, and purchase price, which will automatically increase stock.
• As a Shopkeeper, I should be able to view and edit current stock details, including product name, stock, purchase price, and selling price.
• As a Shopkeeper, I should be able to manage customer credit by recording customer details, outstanding amounts, and payment history.
• As a Shopkeeper, I should be able to manage supplier payments by recording supplier details and amounts due.
• As a Shopkeeper, I should be able to backup and restore data to ensure data integrity and security.

4. User Personas

• Shopkeeper: The primary user who manages the shop's inventory, sales, and purchases.
• Customer: Individuals who purchase products from the shop and may have outstanding credit.
• Supplier: Entities that supply products to the shop and may have pending payments.

5. Core User Flows

• Shopkeeper views Home tab -> sees today's sales, profit, and low stock products.
• Shopkeeper adds a new product -> inputs details -> product is saved.
• Shopkeeper records a sale -> searches product -> inputs quantity -> saves sale -> stock is reduced -> profit is calculated.
• Shopkeeper records a purchase -> inputs product and supplier details -> saves purchase -> stock is increased.
• Shopkeeper manages customer udhar -> records customer details -> adds payments -> views payment history.
• Shopkeeper manages supplier payments -> records supplier details -> adds payments.
• Shopkeeper backs up data -> data is securely stored -> restores data when needed.

6. Visuals Colors and Theme

• primary: #4CAF50 (Green)
• primary_light: #81C784 (Light Green)
• secondary: #FF5722 (Deep Orange)
• accent: #FFC107 (Amber)
• highlight: #FFEB3B (Yellow)
• bg: #FFFFFF (White)
• surface: rgba(255, 255, 255, 0.8)
• text: #212121 (Dark Grey)
• text_muted: #757575 (Grey)
• border: rgba(0, 0, 0, 0.1)

7. Signature Design Concept

The home page of the Stock Management app will feature an interactive dashboard with large, touch-friendly cards that flip to reveal detailed information. Each card represents a key metric such as today's sales, profit, or low stock products. Users can tap on a card to flip it, revealing more detailed statistics and trends. The flipping animation will be smooth and engaging, using framer-motion for spring physics effects. This interactive design will make the app both functional and visually appealing, encouraging shopkeepers to engage with their business data actively.

8. Interaction Model & Motion Direction

• Interaction Model: Animated
• The app will feature moderate scroll-triggered reveals and hover transitions. Interactive elements like buttons and cards will have spring physics applied for a polished user experience. This model is suitable for the app's feature-rich environment while maintaining simplicity and ease of use.

9. Non-Functional Requirements

• The application must be fully offline and operate smoothly on low-end Android phones.
• Fast startup time and clean UI are essential.
• The app must be production-ready, with all screens connected and functional.
• Code should adhere to clean code practices and compile without errors.

10. Tech Stack

• Frontend: Flutter
• Database: SQLite for offline data storage
• Platform: Android 8+

11. Assumptions and Constraints

• The application will only support Android devices running version 8 or higher.
• The app will not include complex settings, dashboards, or advanced architecture to maintain simplicity.
• The app will support both Hindi and English languages.

12. Glossary

• Kirana Shop: A small neighborhood retail shop in India.
• Udhar: Credit or outstanding amount owed by customers.
• CRUD: Create, Read, Update, Delete operations for managing data.