Home / Installation

Installation & Setup

Open Source Project - 100% Free - Licensed under MIT License. No licensing fees, no hidden costs. Use it freely for personal or commercial purposes.

Prerequisites

  1. Install Python 3.13 or higher
  2. Ensure pip is installed and up to date
  3. Git (for cloning repository)

SaleFlex.PyPOS Installation

Step 1: Clone or Download

git clone https://github.com/SaleFlex/SaleFlex.PyPOS.git
cd SaleFlex.PyPOS

Step 2: Create Virtual Environment

python3 -m venv venv

Step 3: Activate Virtual Environment

Windows:

venv\Scripts\activate.bat

macOS/Linux:

source venv/bin/activate

Step 4: Install Dependencies

pip install -r requirements.txt

Step 5: Run the Application

python saleflex.py

First Login

After running the application, you will see the login screen.

Default Login Credentials

Username: admin

Password: admin

Important: Change the default password after first login for security.

After successful login, you will be redirected to the main menu.

Configuration

  • Edit settings.toml to configure database connections, hardware settings, and business parameters
  • The application uses SQLite by default, stored in db.sqlite3
  • For production environments, consider using PostgreSQL or MySQL

Prefer Cloud Service?

No server setup required! If you don't want to deal with server installation and maintenance, you can use SaleFlex.Pro cloud service.

  • Sign up and start managing your stores immediately
  • No server installation or configuration needed
  • Automatic updates and backups
  • Manage all your stores from one cloud dashboard
  • Professional support included
Visit SaleFlex.Pro

System Requirements

Hardware Requirements

  • Devices: Linux/Windows supported touch screen devices
  • Displays: Single or dual display configurations
  • Printers: ESC/P compatible receipt printers
  • Scanners: 2D and 3D barcode readers
  • Scales: Weighing scales for retail environments

Software Requirements

  • Python: 3.13 or higher
  • PySide6: 6.10.0 (Qt-based GUI framework)
  • SQLAlchemy: 2.0.44 (ORM for database operations)
  • Requests: 2.32.5 (HTTP client for API communications)

Common Issues

Python Not Found

If you encounter "python: command not found", try using python3 instead of python.

Virtual Environment Issues

Make sure to activate the virtual environment before installing dependencies or running the application.

For more troubleshooting help, visit our Troubleshooting page.