Skip to main content

OptiFlow Documentation

Complete operations management for optical stores. Manage inventory, invoicing, contacts, and workflows in one powerful platform.

Get StartedAPI Reference

Quick Start

Get your optical store management system up and running in minutes

1

Install Dependencies

Clone the repository and install the required dependencies for both PHP and JavaScript.
git clone https://github.com/luisscruza/optiflow
cd optiflow
composer install
npm install
2

Configure Environment

Set up your environment variables and generate the application key.
cp .env.example .env
php artisan key:generate
OptiFlow uses SQLite by default. For production, configure your preferred database in the .env file.
3

Run Migrations

Initialize your database with the required tables.
php artisan migrate
4

Access Your Application

Start the development server and access OptiFlow.
composer run dev
Your application will be available at:
  • Tenant Portal: https://tenant.optiflow.test
  • Admin Panel: https://optiflow.test/admin
Using Laravel Herd? Your application is automatically available at these URLs without additional configuration.

Explore Core Features

Everything you need to manage your optical store operations

Multi-Workspace

Manage multiple store locations with complete tenant isolation and workspace-based access control.

Product Catalog

Complete product management with pricing, stock tracking, and detailed product information.

Inventory Management

Real-time stock tracking, movements, and transfers between workspaces with full audit trails.

Invoicing

Professional invoice generation with PDF export, tax calculations, and payment tracking.

Quotations

Create quotations and seamlessly convert them to invoices when customers are ready.

Contact Management

Comprehensive customer and supplier directory with relationship tracking.

Learn by Topic

Step-by-step guides for common workflows

Creating Invoices

Learn how to create professional invoices with tax calculations and PDF generation.

Read guide

Managing Inventory

Track stock levels, record movements, and maintain accurate inventory across locations.

Read guide

Stock Transfers

Transfer inventory between workspaces with automatic stock adjustments and tracking.

Read guide

Workflow Automation

Build custom automations with the visual workflow builder to streamline operations.

Read guide

Ready to get started?

Follow our quickstart guide to have OptiFlow running in your environment in just a few minutes.

Get Started Now