Quick Start Guide

Prerequisites

Before you begin, make sure you have the following:

• A server or cloud instance with at least 4GB RAM and 2 CPU cores
• PostgreSQL 12 or higher
• Node.js 16 or higher
• npm or yarn package manager
• A modern web browser (Chrome, Firefox, Safari, or Edge)

Installation

You can install LumiFi using npm or by cloning the repository from GitHub.

Option 1: Using NPM

npm install -g @lumifi/cli

Option 2: Clone from GitHub

git clone https://github.com/lumifi/lumifi.git cd lumifi npm install

After installation, you can initialize the application by running:

npx lumifi init

Configuration

LumiFi uses a `.env` file for configuration. You can create this file manually or use the interactive setup wizard:

npx lumifi setup

The setup wizard will guide you through configuring:

• Database connection details
• Admin username and password
• Server port and host settings
• Email service configuration (optional)
• Network scanning options (optional)

Alternatively, you can manually create a `.env` file with the following variables:

DATABASE_URL=postgresql://user:password@localhost:5432/lumifi JWT_SECRET=your-secret-key PORT=3000 HOST=0.0.0.0 ADMIN_EMAIL=admin@example.com ADMIN_PASSWORD=your-secure-password # Optional settings SMTP_HOST=smtp.example.com SMTP_PORT=587 SMTP_USER=your-smtp-username SMTP_PASS=your-smtp-password

First Steps

Now that you have LumiFi installed and configured, you can start the application:

npx lumifi start

The application will be available at http://localhost:3000 (or the port you configured).

Initial Login

Log in using the admin credentials you configured during setup:

• Email: The email you specified in ADMIN_EMAIL
• Password: The password you specified in ADMIN_PASSWORD

Setting Up Your First Inventory

After logging in, you'll be guided through a quick onboarding process:

1. Create your first inventory location (e.g., "Main Warehouse")
2. Set up product categories (e.g., "Electronics", "Office Supplies")
3. Add your first few products
4. Configure any optional integrations

Screenshot: Main dashboard after initial setup

Next Steps

Now that you have LumiFi up and running, here are some recommended next steps: