83 lines
2.4 KiB
Markdown
83 lines
2.4 KiB
Markdown
---
|
|
type: project
|
|
status: active
|
|
source: git.alwisp.com
|
|
repo: jason/inven
|
|
repo_url: https://git.alwisp.com/jason/inven
|
|
language: TypeScript
|
|
branch: main
|
|
tags: [repo, jason]
|
|
updated: 2026-05-29
|
|
---
|
|
|
|
# inven
|
|
|
|
**Repository:** [jason/inven](https://git.alwisp.com/jason/inven) · branch `main` · TypeScript
|
|
|
|
## Summary
|
|
|
|
Single-container inventory management for Unraid — parts, assemblies, BOMs, sales/purchase orders, invoicing, and a lightweight accounting journal on SQLite
|
|
|
|
## Current status
|
|
|
|
Active. Synced from Gitea on 2026-05-29.
|
|
|
|
## Documentation overview
|
|
|
|
# Inven
|
|
|
|
Inven is a single-container inventory management system for Unraid-style deployments. It manages stocked parts, assemblies built from parts, sales orders and shipping, purchase orders and restocking, customers, vendors, and a lightweight accounting journal on top of SQLite.
|
|
|
|
## Current Scope
|
|
|
|
- Parts and assemblies share one item master
|
|
- Assemblies support bill-of-material component definitions
|
|
- Inventory is tracked through a transaction ledger
|
|
- Sales orders can be created and shipped
|
|
- Purchase orders can be created and received
|
|
- Sales orders and purchase orders are created from relational inventory line selections
|
|
- Shipping and receiving are posted from relational order-line quantity controls
|
|
- Sales orders support partial shipments
|
|
- Purchase orders support partial receipts
|
|
- Invoices are generated from shipped sales orders
|
|
- Vendor bills are generated from received purchase orders
|
|
- Customer and vendor payments can clear receivables and payables
|
|
- Customer and vendor directories support the order flows
|
|
- Low-stock and suggested reorder views help drive replenishment
|
|
- A chart of accounts, account balances, and manual journals support the first accounting pass
|
|
- Built-in authentication protects the app with a bootstrap admin login
|
|
|
|
## Stack
|
|
|
|
- Next.js App Router
|
|
- TypeScript
|
|
- SQLite via `better-sqlite3`
|
|
- Single Docker container with Next.js standalone output
|
|
|
|
## Quick Start
|
|
|
|
1. Install Node.js 22 or newer.
|
|
2. Copy `.env.example` to `.env`.
|
|
3. Set `AUTH_SECRET`, `ADMIN_EMAIL`, and `ADMIN_PASSWORD`.
|
|
4. Update `DATABASE_PATH` if needed.
|
|
5. Install dependencies:
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
6. Start the development server:
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
7. Open `http://localhost:3000` and sign in with the bootstrap admin credentials.
|
|
|
|
|
|
…(truncated — see repo)
|
|
|
|
## Notes
|
|
|
|
- Project file auto-created from repo documentation.
|