Deployment Guide

This guide covers comprehensive deployment instructions for the Inventory Management API, including production deployment, development setup, and local testing environments.

Table of Contents

  1. TOC

Overview

The Inventory Management API can be deployed in several configurations:

Quick Start

Development Environment

# Clone the repository
git clone https://github.com/metanull/inventory-app.git
cd inventory-app

# Install dependencies
composer install
npm install

# Setup environment
cp .env.example .env
php artisan key:generate

# Start development servers
composer dev-start

Production Deployment

# Use the automated deployment script
.\deployment\deploy-windows.ps1 -Domain "your-domain.com"

Architecture Overview

The application follows a modern N-tier architecture:

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚   Web Server    β”‚    β”‚  Laravel API    β”‚    β”‚    Database     β”‚
β”‚  (Apache/Nginx) │◄──►│   Application   │◄──►│   (MariaDB)     β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
         β”‚                       β”‚                       β”‚
         β–Ό                       β–Ό                       β–Ό
    Static Assets          Business Logic          Data Storage
    Vue.js Frontend        REST API Endpoints      Inventory Data
    Image Files            Authentication          Audit Logs

Technology Stack

Component Technology Version Purpose
Backend PHP Laravel 12+ REST API Framework
Frontend Vue.js 3+ Single Page Application
Database MariaDB 10.5+ Production Database
Web Server Apache/Nginx 2.4+/1.18+ HTTP Server
Build Tool Vite 7+ Asset Compilation
Package Manager Composer/NPM Latest Dependency Management

Security Considerations

Performance Optimization


Next Steps