> ## Documentation Index
> Fetch the complete documentation index at: https://lopiv2-invenicum-25.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get Invenicum up and running in under 10 minutes

Get your Invenicum instance running and create your first collection with AI-powered cataloging in just a few minutes.

## Prerequisites

Before you begin, ensure you have:

* **Docker** and **Docker Compose** installed ([Get Docker](https://docs.docker.com/get-docker/))
* A **Google Gemini API key** ([Get one free](https://ai.google.dev/))
* **PostgreSQL** database (can be run via Docker)

## Quick Setup

**1. Create Docker Compose Configuration**

Create a `docker-compose.yml` file in your project directory:

```yaml docker-compose.yml theme={null}
version: '3.8'

services:
  app:
    image: ghcr.io/lopiv2/invenicum:latest
    ports:
      - "3000:3000"
    environment:
      - DB_URL=postgres://user:pass@db:5432/invenicum
      - AI_PROVIDER=gemini
      - GEMINI_API_KEY=your_google_gemini_key_here
    depends_on:
      - db

  db:
    image: postgres:15-alpine
    volumes:
      - ./data/db:/var/lib/postgresql/data
    environment:
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=pass
      - POSTGRES_DB=invenicum
```

> [!WARNING]
>
> Replace `your_google_gemini_key_here` with your actual Gemini API key. Never commit API keys to version control.

**2. Start the Services**

Run Docker Compose to start Invenicum and PostgreSQL:

```bash theme={null}
docker-compose up -d
```

This will:

* Pull the latest Invenicum image
* Start PostgreSQL database
* Initialize the Invenicum application
* Make it available at `http://localhost:3000`

**3. Access the Dashboard**

Open your browser and navigate to:

```
http://localhost:3000
```

You'll be greeted with the login screen. Create your first account by registering.

**4. Create Your First Container**

After logging in:

1. Click **"New Container"** on the dashboard
2. Name it (e.g., "Home Office", "Book Collection")
3. Choose a color and icon
4. Click **Create**

> [!NOTE]
>
> Containers are top-level collections. Think of them as physical locations or categories for organizing your inventory.

**5. Define an Asset Type**

Inside your container:

1. Click **"Add Asset Type"**
2. Name it (e.g., "Books", "Electronics", "Tools")
3. Add custom fields:
   * **Title** (text)
   * **Author** (text) for books
   * **Purchase Price** (price)
   * **Condition** (dropdown)
4. Save the asset type

> [!TIP]
>
> Asset types are templates that define what information to track for each category of items.

**6. Add Your First Item with AI**

Now for the magic! Add an item using AI:

### Option 1: Chat with Veni

1. Click the **AI chat icon** in the bottom right
2. Type: "Add a book called 'Clean Code' by Robert Martin"
3. Veni will extract metadata and create the item

### Option 2: URL Import

1. Click **"Add Item"**
2. Paste a URL (Amazon, eBay, product page)
3. Click **"Auto-fill from URL"**
4. Review and save

### Option 3: Barcode Scan

1. Click **"Scan Barcode"**
2. Use your device camera to scan the UPC/EAN
3. Invenicum fetches market data automatically
4. Review and save

> [!NOTE]
>
> The AI assistant (Veni) uses Google Gemini to intelligently extract product information, saving you time on manual data entry.

**7. Explore Features**

Now that you have your first item:

* **View Dashboard**: See collection stats and market value
* **Create a Loan**: Track when you lend items to friends
* **Generate QR Labels**: Print labels for physical items
* **Set Alerts**: Get notified about low stock or expiring loans
* **Generate Reports**: Export inventory to PDF or Excel

## Next Steps

> **[Installation Guide](https://lopiv2-invenicum-25.mintlify.site/installation.md)**
>
> Learn about advanced deployment options, environment variables, and production setup

> **[Core Features](https://lopiv2-invenicum-25.mintlify.site/features/ai-assistant.md)**
>
> Explore AI-powered features, loan tracking, and dashboard analytics

> **[User Guide](https://lopiv2-invenicum-25.mintlify.site/guides/managing-items.md)**
>
> Master item management, custom fields, and organizational workflows

> **[API Reference](https://lopiv2-invenicum-25.mintlify.site/api/auth/login.md)**
>
> Integrate with Invenicum's REST API for automation and custom tools

## Troubleshooting

> **Port 3000 is already in use**
>
> Change the port mapping in `docker-compose.yml`:
>
> ```yaml theme={null}
> ports:
>   - "8080:3000"  # Now accessible at http://localhost:8080
> ```

> **Can't connect to Gemini AI**
>
> Verify your API key:
>
> 1. Check it's valid at [Google AI Studio](https://ai.google.dev/)
> 2. Ensure it's correctly set in the `GEMINI_API_KEY` environment variable
> 3. Check the logs: `docker-compose logs app`

> **Database connection failed**
>
> Ensure PostgreSQL is running:
>
> ```bash theme={null}
> docker-compose ps
> ```
>
> If the `db` service isn't running, check logs:
>
> ```bash theme={null}
> docker-compose logs db
> ```

## Getting Help

* **Documentation**: Explore the full docs for detailed guides
* **GitHub Issues**: Report bugs at [github.com/lopiv2/invenicum](https://github.com/lopiv2/invenicum/issues)
* **Community**: Check discussions and share templates

> [!NOTE]
>
> For production deployments, review the [Installation Guide](https://lopiv2-invenicum-25.mintlify.site/installation.md) for security best practices, reverse proxy setup, and backup strategies.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.