|
| 1 | +<a id="readme-top"></a> |
| 2 | + |
| 3 | +<!-- EliteSoftware Co. LOGO --> |
| 4 | + |
| 5 | +<br /> |
| 6 | +<div align="center"> |
| 7 | +<!-- <a href="Logo"> --> |
| 8 | +<!-- <img src="https://i.postimg.cc/85MDTcrJ/Elite-Software-LOGO-Mocup2.png" alt="Logo" width="256" height="256"> --> |
| 9 | +<!-- </a> --> |
| 10 | +</div> |
| 11 | + |
| 12 | +<!-- ABOUT THE PROJECT --> |
| 13 | + |
| 14 | +# 💾 About The Project <div align="center"> |
| 15 | + |
| 16 | +## EliteSoftware - AssetManager Pro (Web App Launcher) |
| 17 | + |
| 18 | +`AssetManager Pro` is a comprehensive, self-contained asset management application launched via a PowerShell script. The script initiates a powerful, local web application, driven by a Python backend, that provides a rich user interface for tracking and managing physical and virtual assets. All application data, including a SQLite database, attachments, and backups, is stored permanently in `C:\AssetManager`. |
| 19 | + |
| 20 | +This is a full-featured application designed for individuals, small businesses, or homelab enthusiasts who need a robust system to manage hardware, software, and network resources. |
| 21 | + |
| 22 | +Built by: Zachary Whiteman & Google Gemini Ai. |
| 23 | + |
| 24 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
| 25 | + |
| 26 | +<!-- GETTING STARTED --> |
| 27 | + |
| 28 | +# 🔰 Getting Started |
| 29 | +This launcher script performs a one-time setup and runs a persistent web application. Please review the prerequisites carefully. |
| 30 | + |
| 31 | +## 🕰️ Prerequisites |
| 32 | +To run this application, you will need: |
| 33 | + |
| 34 | +* **Windows Operating System.** |
| 35 | +* **PowerShell 5.1 or newer.** |
| 36 | +* **Python 3.x:** Python must be installed and added to your system's PATH. |
| 37 | +* **Python Libraries:** The script will attempt to automatically install the following required libraries using `pip`: `python-barcode`, `qrcode`, `Pillow`, and `python-nmap`. |
| 38 | +* **Nmap (for Network Discovery):** The `nmap` command-line tool must be installed and in your system's PATH. You can download it from [nmap.org](https://nmap.org/). |
| 39 | +* **Administrator Privileges:** Required for the initial one-time setup to modify the Windows `hosts` file and check for dependencies. The script will self-elevate. |
| 40 | + |
| 41 | +## 💽 Installation & Execution |
| 42 | +1. **Download:** Download the `AssetManager.ps1` script file. |
| 43 | +2. **Unblock:** Right-click the file, go to Properties, and click `Unblock` if the file was downloaded from the internet. |
| 44 | +3. **Run:** Execute the script from a PowerShell console. It will perform a one-time setup if needed, then launch the web server. |
| 45 | + ```powershell |
| 46 | + .\AssetManager.ps1 |
| 47 | + ``` |
| 48 | +4. **Access:** Once the server is running, the script will automatically open the web application in your default browser at `http://asset.manager.local:8080`. |
| 49 | +
|
| 50 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
| 51 | +
|
| 52 | +## 🚀 Key Features |
| 53 | +
|
| 54 | +### Core Asset Management |
| 55 | +* **Full CRUD Operations:** Add, view, edit, and delete assets. |
| 56 | +* **Detailed Tracking:** Fields for name, category, status, purchase date, cost, manufacturer, model, serial number, location, and more. |
| 57 | +* **Check-in / Check-out:** Track who has possession of an asset. |
| 58 | +* **History & Logging:** Every check-in, check-out, and change is logged for a complete audit trail. |
| 59 | +* **Attachments:** Upload images and other files directly to an asset's record. |
| 60 | +* **Archiving:** Archive retired assets to remove them from the main view without deleting their history. |
| 61 | +
|
| 62 | +### Advanced Features |
| 63 | +* **Network Discovery:** Scan your local network with Nmap to discover new devices and add them as assets with one click. |
| 64 | +* **IPAM (IP Address Management):** Define subnets and track IP address assignments to your assets. |
| 65 | +* **Barcode & QR Codes:** Automatically generates unique barcodes and QR codes for every asset, perfect for printing labels. |
| 66 | +* **Kiosk & Scan Modes:** Use a dedicated interface to quickly look up assets with a barcode scanner or your device's camera. |
| 67 | +* **Logistics Management:** Includes modules for managing Software Licenses, Racks, and Vendors. |
| 68 | +* **Data Utilities:** |
| 69 | + * Import and export assets via CSV. |
| 70 | + * Create and restore full database backups. |
| 71 | + * Generate printable sheets of barcode labels for new or existing assets. |
| 72 | +* **Customization:** Use the settings page to change the UI theme, configure asset number prefixes, and set a default user for check-outs. |
| 73 | +
|
| 74 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
| 75 | +
|
| 76 | +## 🛠️ Technology Stack |
| 77 | +* **Launcher/Wrapper:** PowerShell |
| 78 | +* **Web Application Backend:** Python (using the built-in `http.server`). |
| 79 | +* **Database:** SQLite 3. |
| 80 | +* **Frontend:** Standard HTML, CSS, and vanilla JavaScript. |
| 81 | +* **Dependencies:** `python-barcode`, `qrcode`, `Pillow`, `python-nmap`. |
| 82 | +
|
| 83 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
| 84 | +
|
| 85 | +## 📐 Architecture & Security Notes |
| 86 | +* **Self-Contained Application:** All application data, including the Python script, database, and user uploads, is stored in the `C:\AssetManager` directory. |
| 87 | +* **Localhost Only:** The web server is bound to `127.0.0.1` and is intended for local access only. The script adds a `hosts` file entry (`127.0.0.1 asset.manager.local`) for a friendly URL. |
| 88 | +* **Administrator for Setup:** The script only requires administrator rights for the initial setup to check dependencies and modify the hosts file. |
| 89 | +* **Development Server:** The Python web server is for single-user, local application use and is not hardened for a production environment. |
| 90 | +
|
| 91 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
| 92 | +
|
| 93 | +## 🪪 License |
| 94 | +Distributed under the MIT License. See LICENSE.txt for more information. |
| 95 | +
|
| 96 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
| 97 | +
|
| 98 | +## ☎️ Contact |
| 99 | +Zach Whiteman - elitesoftwarecolimited@gmail.com |
| 100 | +
|
| 101 | +HuggingFace - https://huggingface.co/EliteSoftware |
| 102 | +
|
| 103 | +HuggingFace (Personal) - https://huggingface.co/TheShadyRainbow |
| 104 | +
|
| 105 | +LinkTree - https://linktr.ee/zachrainbow |
| 106 | +
|
| 107 | +Patreon - https://www.patreon.com/c/EliteSoftwareCo |
| 108 | +
|
| 109 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
0 commit comments